Qodex.ai

List users in a group

GET {{baseUrl}}/api/v1/groups/:group_Id/users

This API lists a particular number of users in a group, based on the limit defined.

OAuth Scope

  • Desk.search.READ
  • Desk.contacts.READ
  • Desk.settings.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 is 50 and the maximum value allowed is 100.
sortBystringKey that sorts the list of users, based on a specific attribute: -(addedTime)
searchBystringSearch keyword to use for finding a particular user. The keyword must contain at least two characters.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"photoUrl":null,"creator":{"photoUrl":"https://desk.zoho.com/portal/api/user/24073000000095005/photo?orgId=143315","name":"ZylCare Admin","id":"24073000000095005"},"emailAddress":"carol@zylker.com","name":"John ","addedTime":"2019-11-08T14:57:39.000Z","userType":"ENDUSER","label":{"preferences":{"shape":"RECTANGLE","bgColor":"#6CD4DF","textColor":"#FFFFFF"},"name":"Prime Customer","id":"24073000002132001"},"id":"24073000001997453","status":"ACTIVE"}]}