v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Users

Get users

Get a list of users.

Pass a value for the limit parameter in your request if you want retrieve a paginated result. Otherwise API returns a list with all users without pagination.

get/iam/users

Query parameters

limitinteger

The maximum number of items.

offsetinteger

Offset relative to the beginning of list.

Response

OK

countinteger required

Total number of users

nextstring

URL to the next users slice

previousstring

URL to the previous users slice

Example response

{
  "next": "/users?offset=20&limit=10",
  "previous": "/users?offset=10&limit=10",
  "results": [
    {
      "groups": [
        {
          "id": 1,
          "name": "Administrators"
        }
      ],
      "client_and_roles": [
        {
          "user_roles": [
            "2"
          ]
        }
      ]
    }
  ]
}