Qodex.ai

List user groups

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

This API lists a particular number of user groups in a help center, based on the limit defined.

OAuth Scope

  • Desk.contacts.READ
  • Desk.settings.READ

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number, starting from which the groups must be fetched. The default value is 1
limitstringNumber of groups 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 user groups by a particular attribute: -(addedTime)
helpCenterIdstringID of the help center from which the groups must be fetched

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"addedTime":"2020-04-06T04:50:50.000Z","name":"Zoho CRM Partners","id":"24073000002957057","helpCenterId":"24073000002733221","logoUrl":null,"status":"ACTIVE"},{"addedTime":"2020-04-06T04:50:30.000Z","name":"Zoho Desk Partners","id":"24073000002957051","helpCenterId":"24073000002733221","logoUrl":"https://desk.zoho.com/portal/api/publicImages/24073000002959001?portalId=b363e6f8e029247a38a55e49806bf1f683801f9cd92870bf7cc50d48844902f0","status":"ACTIVE"},{"addedTime":"2020-04-06T04:50:14.000Z","name":"Zoho One Prime Customers","id":"24073000002957045","helpCenterId":"24073000002733221","logoUrl":null,"status":"ACTIVE"}]}