Gets a list of agents by status.
Request Variables
| Path | Type | Description |
states | array of strings | Agent statuses separated by commas to filter the response. To retrieve all active agents in any status, use the 'states=ALL' query. |
Permissions
---- Permissions:INTEGRATOR,SUPERVISOR,OPERATOR,BOT ----
HTTP Request
GET /api/v1/agents?states=INACTIVE&states=PRE_INACTIVE&page=0&size=2 HTTP/1.1 Authorization: Bearer <integrator_token> Host: localhost:8080
Example of a Successful HTTP Response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 439
[
{
"id": 152,
"login": null,
"status": "INACTIVE",
"reason": "system",
"activeThreads": null,
"lastActionTime": "2019-09-19T20:00:00.000Z",
"lastStateChange": "2019-09-19T20:00:00.000Z"
},
{
"id": 153,
"login": null,
"status": "PRE_INACTIVE",
"reason": "lunch",
"activeThreads": null,
"lastActionTime": "2019-09-19T20:00:00.000Z",
"lastStateChange": "2019-09-19T20:00:00.000Z"
}
]