Get agent details by agentId
GET {{baseUrl}}/api/v1/agentsByIds?agentIds=:agent_ids?agentIds=<long>
This API fetches details of agents via the agent IDs passed in the API request.
OAuth Scope
Desk.settings.READ
Desk.basic.READ
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
agentIds | string | Comma-separated array of agent IDs. Maximum number of IDs allowed is 50. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"firstName":"","lastName":"case","photoURL":null,"roleId":"7000000012324","profileId":"7000000012339","emailId":"case@zylker.com","id":"1892000000056007","zuid":"437793"},{"firstName":"","lastName":"jade","photoURL":"https://desk.zoho.com/api/v1/agents/1892000000042001/photo?orgId=3981311","roleId":"7000000012324","profileId":"7000000012339","emailId":"jade@zylker.com","id":"1892000000042001","zuid":"279392"},{"firstName":"Steve","lastName":"Waugh","photoURL":"https://desk.zoho.com/api/v1/agents/1892000000888059/photo?orgId=3981311","roleId":"70000000127346","profileId":"70000000120834","emailId":"stephen@zylker.com","id":"1892000000888059","zuid":"91723912"}]}