The "Get the List of Users" API allows you to retrieve the list of users and their statuses from your Aloware account when called with the unique API token. This is useful for further automation in Aloware’s APIs and Integration.
This documentation outlines the required fields, examples, and endpoints to successfully utilize the Aloware User List API.
Endpoint
This endpoint allows you to get a list of users.
GET /api/v1/webhook/users
Getting the list of users
To get the list of users, you need the following required fields:
api_token | Your Aloware account API token. |
Example GET URL
https://app.aloware.com/api/v1/webhook/users?api_token=[API_TOKEN]
Response
HTTP 200 - a successful response will return a JSON array containing user details and their current agent status.
Example request
[
{
"id":1,
"name":"John Doe",
"email":"[email protected]",
"agent_status":1,
"human_readable_agent_status":"Available"
}
]
List of agent statuses
The following are the possible agent statuses and their corresponding integer values:
{
"0":"Offline",
"1":"Available",
"2":"Busy",
"3":"On Break",
"4":"On Call",
"5":"Wrap-up",
"6":"Ringing"
}
cURL example
curl --location --request GET 'https://app.aloware.com/api/v1/webhook/users?api_token=[API_TOKEN]'
Make sure to replace '[API_TOKEN]' with your actual Aloware API token.