Get Agents
GET https://api.helpshift.com/v1/{{domain}}/agents
Get all agents.
Allows filtering by role. Optionally returns the last login time for each agent, if available.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
roles | string | Filter by role - admin, agent, supervisor (JSON array of strings) | |
page | number | Page being requested. | |
page-size | number | Number of results per page. | |
includes | string | Optional list of extra information to be included in the response. Valid options are - | |
| last_login_at - time of last login for each agent |
RESPONSES
status: OK
{"page":1,"page-size":100,"profiles":[{"id":"moana_profile_20201124080208068-6156715572149ac","name":"Agent1","nickname":"Agent1","email":"agent1@gmail.com","avatar":"https://secure.gravatar.com/avatar/184efcb2b64fb7c4a35dc22bf95e3ea6?s=256\u0026d=https://d3e51fp79zp4el.cloudfront.net/images/dp_256.png","role":"agent","team_name":"Team Moana"},{"id":"moana_profile_20201124080228849-504753218485d8b","name":"Agent2","nickname":"Agent2","email":"agent2@gmail.com","avatar":"https://secure.gravatar.com/avatar/880ec3c41302d4dc57d4008dd39027a3?s=256\u0026d=https://d3e51fp79zp4el.cloudfront.net/images/dp_256.png","role":"agent","team_name":"Team Moana"},{"id":"moana_profile_20201124080248344-134e27c9a7d8a5d","name":"Agent3","nickname":"Agent3","email":"agent3@gmail.com","avatar":"https://secure.gravatar.com/avatar/fc97cf0166549a0516b532fa026dc29b?s=256\u0026d=https://d3e51fp79zp4el.cloudfront.net/images/dp_256.png","role":"agent","team_name":"Team Moana"}],"total-profiles":3,"total-pages":1}