Qodex.ai

Get agent

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

This API fetches details of an agent in your help desk.

OAuth Scope

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

Request Params

KeyDatatypeRequiredDescription
includestringSecondary information related to the agent. Values allowed are profile, role, associatedDepartments, and associatedChatDepartments. You can include all four values by separating them with commas in the API request.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"associatedChatDepartments":[{"name":"Developement","id":"1892000000006907"}],"lastName":"case","extn":"3298","role":{"name":"CEO","id":"1892000000056099"},"langCode":"fr_FR","emailId":"case@zylker.com","photoURL":null,"countryCode":"en_US","isConfirmed":true,"id":"1892000000056096","roleId":"1892000000056099","profile":{"name":"Administrator","id":"1892000000056091"},"mobile":"","timeZone":"Pacific/Majuro","associatedChatDepartmentIds":["1892000000006907"],"zuid":"10687231","associatedDepartmentIds":["1892000000006907","1892000000082069"],"associatedDepartments":[{"name":"Developement","id":"1892000000006907"},{"name":"R \u0026 D","id":"1892000000082069"}],"firstName":"","phone":"492-736-6424","profileId":"1892000000056091","channelExpert":["Facebook","Chat","Phone","Twitter","Web","Email","Forums"],"name":"case","rolePermissionType":"Admin","aboutInfo":"Expert in handling tickets and Automations","status":"ACTIVE"}