Retrieve group resources by user ID

1 min

GET

https://api.ionos.com/cloudapi/v6/um/users/{userId}/groups

Retrieve group resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.

userIdstringThe unique ID of the user.

prettybooleanControls whether the response is pretty-printed (with indentations and new lines).

depthinteger<int32>Controls the detail depth of the response objects. NOTE: The resource /um and its children support a maximum depth level of 1. It will provide you the entry points to specific user related resources. As these resources are partially servered by other service components, they must be retrieved explicitly. Any depth parameter beyond '?depth=1' will be deprecated by April 30, 2026.

acceptstringGenerated from available response content types

X-Contract-Numberinteger<int32>Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

200Successful operation

defaultAny erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

curl --request GET \
     --url 'https://api.ionos.com/cloudapi/v6/um/users/{userId}/groups?pretty=true&depth=integer%3Cint32%3E' \
     --header 'accept: application/json'

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.