Users API

Pull every user on your Aloware account, along with each one's current agent status, with one GET request and your API token. That list helps when you build further automation on Aloware's APIs and integrations.

• Method: GET
• Auth: your account API token, in the query string as api_token
• Format: JSON out (an array of users)

Endpoint

Call this to list your users:

GET /api/v1/webhook/users

Fields

Only one parameter, and it's required:

Request example

https://app.aloware.io/api/v1/webhook/users?api_token=[API_TOKEN]

Responses

200: success

You get back a JSON array with one entry per user: their details and their agent status right now.

[
   {
      "id":1,
      "name":"John Doe",
      "email":"jdoe@email.com",
      "agent_status":1,
      "human_readable_agent_status":"Available"
   }
]

Agent status values

agent_status is a number. Here is what each value means:

{
   "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.io/api/v1/webhook/users?api_token=[API_TOKEN]'

Put your own Aloware API token in place of '[API_TOKEN]'.