Qodex.ai

List agents in department

GET {{baseUrl}}/api/v1/departments/:department_id/agents

This API lists the agents in a department.

OAuth Scope

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

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number, starting from which the agents must be listed
limitstringNumber of agents to fetch; default value is 10 and maximum value is 200
statusstringKey that filters agents, based on their activation status: ACTIVE or DISABLED
isLightAgentstringKey that denotes if the agents must be light or non light.
isConfirmedstringKey that denotes if the agents must be confirmed or unconfirmed.
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":"","emailId":"case@zylker.com","associatedChatDepartmentIds":[],"zuid":"10687231","associatedDepartmentIds":["1892000000006907","1892000000082069","1892000000639717"],"firstName":"","photoURL":null,"phone":"12121","profileId":"1892000000056091","countryCode":"en_US","channelExpert":["Facebook","Chat","Phone","Twitter","Web","Email","Forums"],"name":"case","isConfirmed":true,"aboutInfo":"Expert in handling tickets and Automations","id":"1892000000056007","status":"ACTIVE"},{"lastName":"jade","extn":"3203","roleId":"1892000000056899","langCode":"en_US","mobile":"","emailId":"jade@zylker.com","associatedChatDepartmentIds":[],"zuid":"10657727","associatedDepartmentIds":["1892000000006907","1892000000082069","1892000000639717","1892000001019041","1892000001106673","1892000001109673"],"firstName":"","photoURL":"https://contacts.zoho.com/file?t=user\u0026ID=10657727","phone":"","profileId":"1892000000056091","countryCode":"en_US","channelExpert":["Facebook","Email","Forums"],"name":"jade","isConfirmed":true,"aboutInfo":"Expert in handling tickets","id":"1892000000042001","status":"ACTIVE"},{"lastName":"john","extn":"3228","roleId":"1892000000056004","langCode":"en_US","mobile":"","emailId":"john@zylker.com","associatedChatDepartmentIds":[],"zuid":"10713988","associatedDepartmentIds":["1892000000006907","1892000001019041"],"firstName":"","photoURL":null,"phone":"68779989","profileId":"18920000000232043","countryCode":"en_US","channelExpert":["Facebook","Chat","Phone","Twitter","Web","Email","Forums"],"name":"john","isConfirmed":true,"aboutInfo":"Expert in handling tickets and Automations","id":"1892000000070001","status":"DISABLED"},{"lastName":"Waugh","extn":"4020","roleId":"1892000000056004","langCode":"ja_JP","mobile":"","emailId":"stephen@zylker.com","associatedChatDepartmentIds":[],"zuid":null,"associatedDepartmentIds":["1892000000006907","1892000000082069","1892000000639717"],"firstName":"Steve","photoURL":null,"phone":"","profileId":"18920000000232043","countryCode":"en_US","channelExpert":["Facebook","Chat"],"name":"Steve Waugh","isConfirmed":false,"aboutInfo":"Expert in handling Departments","id":"1892000000888059","status":"ACTIVE"}]}