/user_group/{id}

Get user group

Retrieves a user group by its ID.

Base URL
https://<tenant>.dieagenturverwaltung.de/api/v2
Required Security
ApiKeyAuth (Authorization: Session Token)
Produces
application/json

Request

Path Parameters

NameTypeRequiredDescription
idintegerYesUser Group ID
cURL
curl -X GET 'https://<tenant>.dieagenturverwaltung.de/api/v2/user_group/123' \
  -H 'Accept: application/json' \
  -H 'Authorization: Session Token'

Responses

200OK
app.UserGroupapplication/json
Example
{
  "actions": [
    {...}
  ],
  "dashboard_tiles": [
    {...}
  ],
  "id": 123,
  "name": "string",
  "small_users": [
    {...}
  ],
  "users": [
    {...}
  ]
}
400Bad Request
rest_errors.Errorapplication/json
Example
{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}
404Not Found
rest_errors.Errorapplication/json
Example
{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}
500Internal Server Error
rest_errors.Errorapplication/json
Example
{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}