Retrieve all Users
This function retrieves all users
from the client account.
URL
GET {baseURL}/users
Parameters
None
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the following fields:
| Field | Type | Data |
|---|---|---|
| filter | String | The applied filter. This is reserved for future use. |
| limitStart | Integer | The first record index. Currently 0, reserved for future use. |
| limitPageSize | Integer | The number of records. -1 indicates all records. Reserved for future use. |
| records | Users [] | An array of users. |
| count | Integer | The number of records returned. |
| orderBy | String | The field used to sort the records. |
| ascending | Boolean | Whether the array of records is sorted ascending or descending. |
| status | Integer | The return code (also provided by the http status code). |
Example
Note, the records array has been shortened for readability.
{
"filter": "",
"limitStart": 0,
"limitPageSize": -1,
"records": [
{
"bTelCallsForwarding": false,
"bUseWebMail": false,
"dtPBXTelephoneStatus": null,
...
"ResellersID": 1,
"TelStatusID": 0,
"AgentStatusAfterLogoutRejectedID": null
}
],
"count": 22,
"orderBy": "UID",
"ascending": true,
"status": 200
}
Retrieve a specific User by ID
This function retrieves a specific user by ID.
URL
GET {baseURL}/users/user/{UsersID}
Parameters
| Parameter | Where | Type | Data |
|---|---|---|---|
| UsersID | URL | Integer | The ID of the user. |
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the returned data.
| Field | Type | Data |
|---|---|---|
| records | Users [] | An array of users, containing one user. |
| count | Integer | 1 |
| status | Integer | The return code (also provided by the http status code). |
Example
Note, the record array has been shortened for readability.
{
"records": [
{
"bTelCallsForwarding": false,
"bUseWebMail": true,
"dtPBXTelephoneStatus": "2020-07-07T06:20:14.558",
"bUseWebEmail": true,
...
"ResellersID": 1,
"TelStatusID": 0,
"AgentStatusAfterLogoutRejectedID": null
}
],
"count": 1,
"status": 200
}
Retrieve User by UID
This function retrieves one or more users depending on the passed UID. If more than one user is available which matches the UID passed (partial match), then all corresponding users will be returned.
URL
GET {baseURL}/users/user?uid={UID}
Parameters
| Parameter | Where | Type | Data |
|---|---|---|---|
| UID | Query | String | The UID of the user(s) to retrieve. |
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the returned users.
| Field | Type | Data |
|---|---|---|
| records | User [] | An array of users. |
| count | Integer | The number of records returned. |
| status | Integer | The return code (also provided by the http status code). |
Example
Note, the records array has been shortened for readability.
{
"records": [
{
"bTelCallsForwarding": false,
"bUseWebMail": true,
"dtPBXTelephoneStatus": "2020-07-07T06:20:14.558",
...
"ResellersID": 1,
"TelStatusID": 0,
"AgentStatusAfterLogoutRejectedID": null
}
],
"count": 2,
"status": 200
}