Qodex.ai

List help center users

GET {{baseUrl}}/api/v1/users

This API lists a particular number of help center users, based on the limit defined. It also helps you search for specific users.

OAuth Scope

  • Desk.search.READ
  • Desk.contacts.READ
  • Desk.settings.READ
  • Desk.basic.READ

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number, starting from which the users must be fetched. The default value is 1.
limitstringNumber of users to list. The default value and the maximum value allowed is 50.
searchBystringSearch keyword to use for finding a particular user. The keyword must contain at least two characters.
sortBystringKey that sorts the list of users by a particular attribute: -(email or modifiedTime)
statusstringActivation status of the users to list
helpCenterIdstringID of the help center from which the users must be fetched
includestringAdditional information related to the user. Value allowed is count.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"lastAccessedTime":"2021-06-11T06:21:32.000Z","photoURL":"https://desk.zoho.com/portal/api/portalUser/17883000000094001/photo","emailAddress":"carol@zylker.com","name":"Developer","id":"310975130121","label":{"preferences":{"shape":"RECTANGLE","bgColor":"#39B54A","textColor":"#FFFFFF"},"name":"Lock Label","id":"24073000002823026","logoUrl":null},"type":"ENDUSER","status":"ACTIVE"}],"count":"1"}