Listing all groups assigned to a user account¶

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

Description¶

The List-Users-Groups request allows the user to request a list of all groups assigned to a user account of the organisation.

Requirements¶

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

Objects: none

Request¶

To request a list of all groups assigned to a user account, no additional information needs to be added 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 group.	`string`
`children`	An array with sub groups of the main group, each presented as object `GroupVO` and possible other `children` as sub group.	`array`
`roles`	An array with the roles the requested user account has in this group.	`ADMINISTRATOR` `USER`
`membersCount`	The number of all users in the group.	`integer`
`type`	Shows if a user account is a normal user 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": [],
    "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	A list of `GroupVO` elements.
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.