Agent List API

The REST API is used to get the active agents list along with their state and attributes.

The server responds with a list of active agents. Please note that this API will not return supervisor users.

Protocol	HTTP or HTTPS
URL	http://<FQDN>/api/external/agents/list or https://<FQDN>/api/external/agents/list
Content Type	Application/JSON
HTTP Method	GET
Input/Output Format	JSON
HTTP Request	-
Request Parameters
HTTP Response	200: Success 404: Not found 500: Internal Server Error 503: Service Unavailable
Example Response	CODE [ { "id":"5c88a4d32cc50463a0787a9b", "agentId":"faisal", "state":"READY", "firstName":"Faisal", "lastName":"Nawaz", "attributes":[ { "createdDate":"2019-03-13T07:00:31.189Z", "_id":"5c88aa8f3cdebc7f01c5c428", "__v":0, "name":"Sale", "description":null, "type":"Boolean", "value":"false", "usageCount":null } ] }, { "id":"5c88a4d32cc5046cd3787a9c", "agentId":"awais", "state":"NOT_READY", "firstName":"awais", "lastName":"aslam", "attributes":[ ] } ]