Customer success center

Login Sign up

Web Services API | Groups Web services | Get root groups

Modified on: Thu, 13 Apr 2023 4:30 PM

Get root groups

Returns a list with root groups.

  • URL: /integration/ws/management/rest/groups.roots
  • Method: GET
  • Headers:
    • Accept: version/format header
    • X-Cloud-Auth-Token*: authorization header
  • Parameters: 
    • startIndex: index of the first group to list
    • count: maximum number of group to list (default and limit 500)
  • Responses:
    • 200: OK. Content: JSON array with root groups data.
  • Request example:
  • Response example:
    • Payload: [{"codGroup":"RootX","description":null,"extra":{},"id":"8a80807d5af0355e015af03acd580000","image":{"url":null},"name":"RootX","parentId":null,"roles":{}},{"codGroup":"Root2X","description":null,"extra":{},"id":"8a80807d5af0355e015af0408fac0002","image":{"url":null},"name":"Root2X","parentId":null,"roles":{"management":["user"]}}]

(*) Field "isOrganization" only applies in customers with multiorganización enabled and root groups

Was this answer helpful?