Skip to main content
GET
/
api
/
v1
/
users
/
List all users
curl --request GET \
  --url https://services.pref.rio/heimdall-admin/api/v1/users/ \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": 1,
      "cpf": "12345678901",
      "display_name": "João Silva",
      "groups": [
        "engineering_team:backend"
      ],
      "roles": [
        "superadmin"
      ]
    },
    {
      "id": 2,
      "cpf": "98765432109",
      "display_name": "Maria Santos",
      "groups": [
        "data_analysts:read"
      ],
      "roles": [
        "data-analyst"
      ]
    }
  ],
  "total": 150,
  "skip": 0,
  "limit": 50,
  "has_more": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
skip
integer
default:0

Number of users to skip

Required range: x >= 0
​
limit
integer
default:50

Maximum number of users to return

Required range: 1 <= x <= 100

Response

Users retrieved successfully

​
items
UserResponse · object[]
required

List of items for the current page

​
total
integer
required

Total number of items available

Required range: x >= 0
Example:

150

​
skip
integer
required

Number of items skipped (offset)

Required range: x >= 0
Example:

0

​
limit
integer
required

Maximum number of items returned

Required range: 1 <= x <= 100
Example:

50

​
has_more
boolean
required

Whether there are more items available

Example:

true

⌘I