Get Agent’s Status

Returns an agent’s current status and status reason (if applicable).

userVariableNamePossible values: id/login – agent variable



Curl Example

$ curl 'http://localhost:8080/api/v1/agents/1/status?userVariableName=id' -i -X GET \
    -H 'Authorization: Bearer <integrator_token>'

HTTP Request

GET /api/v1/agents/1/status?userVariableName=id 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: 168
    "id": null,
    "login": null,
    "status": "OFFLINE",
    "reason": "reason",
    "activeThreads": 4,
    "lastActionTime": null,
    "lastStateChange": null
Update Agents
Next Article Set Agent’s Status