REST API
Get familiar with the Applivery API and explore the features
Get list of Employees of an App
This request is intended to get the list of Employees (end-users) invited to a given App.
Definition:
GET https://api.applivery.io/v1/integrations/employees
- Authentication: required
- Headers:
- Content-Type: application/json
- Authorization: bearer <Your_App_Token>
| Param | Type | Description |
|---|---|---|
page |
String |
Page number |
limit |
String |
Limit number of results |
email |
String |
Filter by email |
CURL Request Example
curl 'https://api.applivery.io/v1/integrations/employees' -X GET -H 'Authorization: bearer xyz...xyz'
Responses
{
"status": true,
"data": {
"items": [
{
"id": "5d5d3183ab0c040ae22c4651",
"from": "dashboard",
"type": "traditional",
"email": "employee3@applivery.com"
},
{
"id": "5d5d317dab0c041ba82c464d",
"from": "dashboard",
"type": "traditional",
"email": "employee2@applivery.com"
},
{
"id": "5d5d3174ab0c048ed62c4649",
"from": "dashboard",
"type": "traditional",
"email": "employee1@applivery.com"
}
],
"totalDocs": 3,
"limit": 100,
"hasPrevPage": false,
"hasNextPage": false,
"page": 1,
"totalPages": 1,
"pagingCounter": 1,
"prevPage": null,
"nextPage": null
}
}
{
"status": true,
"error": {
"code": 2001,
"message": "Token not valid"
}
}
{
"status": true,
"error": {
"code": 4001,
"message": "Entity not found"
}
}