Getting a user group¶

Send a GET request to the endpoint /user/groups/{id}.

Description¶

The Get-User-Groups request allows the user to request a user group with sub groups of the organisation.

Requirements¶

Values of the request: Group-ID {id}d}

Objects: none

Request¶

To request a user group, add the Group-ID {id} to the path of the request.

As a result, the user gets one or more objects GroupVO with the requested information.

The object provides the following information:

Attributes	Description	Values
`name`	The name of the user group. Starting with the root user group in the list of `GroupVO`.	`string`
`children`	An array with sub user groups of the parent user group, each presented as object `GroupVO` and possible other `children` as sub user group.	`array`
`parent`	The ID of the parent user group. Appears only if the user group is a subgroup.	`integer`
`roles`	An array with the roles the requested user account has in this user group.	`ADMINISTRATOR` `USER`
`membersCount`	The number of all user accounts in the user group.	`integer`
`type`	Shows if a user account is a normal user account of an organisation or a user account with agent permissions.	`USER` `AGENT`
`id`	The ID of the entry.	`integer`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

Example¶

Example response:

{
  "name": "string",
  "children": [],
  "parent": 0,
  "roles": "ADMINISTRATOR",
  "membersCount": 0,
  "type": "USER",
  "id": 0,
  "modified": "2026-01-01T00:00:00+00:00",
  "created": "2026-01-01T00:00:00+00:00"
}

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.