List agents by profile

GET {{baseUrl}}/api/v1/profiles/:profile_id/agents

This API lists agents mapped to a particular profile.

OAuth Scope

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

Request Params

KeyDatatypeRequiredDescription
activestringActivation status of the agents to list
confirmedstringConfirmation status of the agents to list

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"agents":[{"firstName":"","lastName":"John","photoURL":"https://contacts.zoho.com/file?t=user\u0026ID=437793","roleId":"7000000012324","profileId":"6000000011303","emailId":"john@zylker.com","id":"7000000013328","zuid":"437793"},{"firstName":"Steve","lastName":"Kyle","photoURL":null,"roleId":"7000000012324","profileId":"6000000011303","emailId":"kyle@zylker.com","id":"7000000012958","zuid":"5625416"}]}