This API allows you to fetch a detailed list of Users.
Sample Request
curl --request GET \
--url https://api-account-uk.acefone.com/v1/users \
--header 'accept: application/json'📘 Important!
Before we begin, note that the * sign denotes the mandatory variables in each table.
Request Variables (Query Params)
The following parameter is required to fetch multiple users:
| Variable Name | Description | Data Type |
|---|---|---|
| last_seen_id | Provide results after this id. | Integer. |
| limit | Provides user count according to limit. | Integer. |
| is_extension_created | User details with and without extension respectively. | Boolean. |
| is_login_based_calling | Login based calling disabled or enabled on users. | Boolean. |
| is_international_calling | International calling disabled or enabled on users. | Boolean. |
| is_web_login | Web login disabled or enabled on users. | Boolean. |
| user_status | User disabled or enabled on users. | Boolean. |
Sample Response
{
"has_more": true,
"count": 20,
"last_seen_id": 370822,
"data": [
{
"id": 314678,
"name": "xyz",
"agent": {
"id": "0502842370097",
"name": "xyz",
"status": 0,
"follow_me_number": "+911111111111"
},
"login_id": "[email protected]",
"is_login_based_calling_enabled": false,
"is_international_outbound_enabled": false,
"user_role": {
"id": 54630,
"name": "Quality"
},
"extension": null,
"user_status": 1
}
]
}
Response Variables
The response returned is as following:
Variable Name | Description | Data Type |
|---|---|---|
has_more | It defines whether there exist more records or not. For example: true or false. | Boolean |
count | Total number of records in current page. | integer |
last_seen_id | reference id of last user in the current page. | integer |
data[i].id | Id of the user. | integer |
data[i].name | Name of the user. | String |
data[i].agent.id | Id of the agent. | String |
data[i].agent.name | Name of the agent. | String |
data[i].agent.status | Status of the agent. For example: Enabled = 0 | integer |
data[i].agent.follow_me_number | Phone number of the agent. | String |
data[i].login_id | Login Id of the user. | String |
data[i].is_login_based_calling_enabled | Whether login-based calling is enabled on the user or not. For example: true or false. | Boolean |
data[i].is_international_outbound_enabled | Whether internation outbound is enabled on the user or not. For example: true or false. | Boolean |
data[i].user_role.id | Id of the permission role defined for the user. | integer |
data[i].user_role.name | Name of the permission role defined for the user. | String |
data[i].extension | Extension assigned to the user. | String |
data[i].user_status | Current status of the user account. | integer |