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

KeyDatatypeRequiredDescription
agentIdsstringComma-separated array of agent IDs. Maximum number of IDs allowed is 50.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;firstName&quot;:&quot;&quot;,&quot;lastName&quot;:&quot;case&quot;,&quot;photoURL&quot;:null,&quot;roleId&quot;:&quot;7000000012324&quot;,&quot;profileId&quot;:&quot;7000000012339&quot;,&quot;emailId&quot;:&quot;case@zylker.com&quot;,&quot;id&quot;:&quot;1892000000056007&quot;,&quot;zuid&quot;:&quot;437793&quot;},{&quot;firstName&quot;:&quot;&quot;,&quot;lastName&quot;:&quot;jade&quot;,&quot;photoURL&quot;:&quot;https://desk.zoho.com/api/v1/agents/1892000000042001/photo?orgId=3981311&quot;,&quot;roleId&quot;:&quot;7000000012324&quot;,&quot;profileId&quot;:&quot;7000000012339&quot;,&quot;emailId&quot;:&quot;jade@zylker.com&quot;,&quot;id&quot;:&quot;1892000000042001&quot;,&quot;zuid&quot;:&quot;279392&quot;},{&quot;firstName&quot;:&quot;Steve&quot;,&quot;lastName&quot;:&quot;Waugh&quot;,&quot;photoURL&quot;:&quot;https://desk.zoho.com/api/v1/agents/1892000000888059/photo?orgId=3981311&quot;,&quot;roleId&quot;:&quot;70000000127346&quot;,&quot;profileId&quot;:&quot;70000000120834&quot;,&quot;emailId&quot;:&quot;stephen@zylker.com&quot;,&quot;id&quot;:&quot;1892000000888059&quot;,&quot;zuid&quot;:&quot;91723912&quot;}]}