Qodex.ai

List agents

GET {{baseUrl}}/api/v1/agents

This API lists a particular number of agents, based on the limit specified.

OAuth Scope

  • Desk.settings.READ
  • Desk.basic.READ

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number, starting from which the agents must be fetched
limitstringNumber of agents to fetch. The default value is 10 and the maximum value supported is 200.
statusstringKey that filters agents based on their activation status: ACTIVE or DISABLED
departmentIdsstringComma-separated array of department IDs. Maximum number of IDs allowed is 50.
profileIdsstringComma-separated array of profile IDs. Maximum number of IDs allowed is 50.
roleIdsstringComma-separated array of role IDs. Maximum number of IDs allowed is 50.
rolePermissionTypestringTypes of roles and permissions of the agents to list. Values allowed are AgentPublic, AgentPersonal,AgentTeamPersonal, Admin, Light, Custom, and ${NON_LIGHT}. ${NON_LIGHT} refers to agents who are not associated with the light agent profile.
isConfirmedstringKey that denotes if the agents must be confirmed or unconfirmed.
isLightAgentstringKey that denotes if the agents must be light or non light.
includestringSecondary information related to agents, Values allowed are profile, role. You can include all two values by separating them with commas in the API request.
searchStrstringString to search for agents by first name, last name, or email ID. The string must contain at least one character. Three search methods are supported: 1) string* - Searches for agents whose first name, last name, or email ID start with the string, 2) string - Searches for agents whose first name, last name, or email ID contain the string, 3) string - Searches for agents whose first name, last name, or email ID is an exact match for the string
fieldNamestringName of the field that must be used for searching and listing agents. Values allowed are: firstName, lastName, name, and emailId
sortOrderstringTo sort the available list of agents in either ascending or descending order. Values allowed are: asc or desc

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"lastName":"case","extn":"3298","roleId":"1892000000056099","langCode":"en_US","mobile":"","timeZone":"Asia/Kolkata","emailId":"case@zylker.com","associatedChatDepartmentIds":[],"zuid":"10687231","associatedDepartmentIds":["1892000000006907","1892000000082069","1892000000639717"],"firstName":"zyl","photoURL":null,"phone":"492-736-6424","profileId":"1892000000056091","countryCode":"en_US","channelExpert":["Facebook","Chat","Phone","Twitter","Web","Email","Forums"],"name":"zyl case","rolePermissionType":"Admin","isConfirmed":true,"aboutInfo":"Expert in handling tickets and Automations","id":"1892000000056007","status":"ACTIVE"},{"lastName":"jade","extn":"3203","roleId":"1892000000056899","langCode":"en_US","mobile":"","timeZone":"Asia/Kolkata","emailId":"jade@zylker.com","associatedChatDepartmentIds":[],"zuid":"10657727","associatedDepartmentIds":["1892000000006907","1892000000082069","1892000000639717","1892000001019041","1892000001106673","1892000001109673"],"firstName":"","photoURL":"https://desk.zoho.com/api/v1/agents/1892000000042001/photo?orgId=3981311","phone":"","profileId":"1892000000056091","countryCode":"en_US","channelExpert":["Facebook","Chat","Phone","Twitter","Web"],"name":"jade","rolePermissionType":"Light","isConfirmed":true,"aboutInfo":"Expert in handling tasks","id":"1892000000042001","status":"ACTIVE"},{"lastName":"john","extn":"3228","roleId":"1892000000056004","langCode":"en_US","mobile":"","timeZone":"Asia/Kolkata","emailId":"john@zylker.com","associatedChatDepartmentIds":[],"zuid":"10713988","associatedDepartmentIds":["1892000000006907","1892000001019041"],"firstName":"","photoURL":null,"phone":"68779989","profileId":"18920000000232043","countryCode":"en_US","channelExpert":["Chat","Phone","Twitter","Web","Email"],"name":"john","rolePermissionType":"AgentPersonal","isConfirmed":true,"aboutInfo":"Expert in handling Workflows and Agents","id":"1892000000070001","status":"DISABLED"},{"lastName":"Waugh","extn":"4020","roleId":"1892000000056004","langCode":"ja_JP","mobile":"","timeZone":"Asia/Tokyo","emailId":"stephen@zylker.com","associatedChatDepartmentIds":[],"zuid":null,"associatedDepartmentIds":["1892000000006907","1892000000082069","1892000000639717"],"firstName":"Steve","photoURL":null,"phone":"","profileId":"18920000000232043","countryCode":"en_US","channelExpert":[],"name":"Steve Waugh","rolePermissionType":"Custom","isConfirmed":false,"aboutInfo":"Expert in handling Knowledge base and comunity ","id":"1892000000888059","status":"ACTIVE"}]}