List all users

Retrieve a paginated list of all users in the system.

GET /v1/users

Try it

List all users

cURL

curl --request GET \
  --url https://api.example.com/v1/users

200

{
  "data": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "username": "<string>",
      "role": "SYSTEM",
      "auth_method": "<string>",
      "password_needs_reset": true,
      "password": "<string>"
    }
  ],
  "next_cursor": "<string>"
}

Query Parameters

cursor · string

Cursor for pagination (base64-encoded user ID)

limit · integer · default: 100

The max number of users to return at a time.

Response

200

application/json

A list of users.

data · (LocalUser · object | OAuth2User · object | LDAPUser · object)[] · required

LocalUser

OAuth2User

LDAPUser

Show child attributes

data. id · string · required

data. created_at · string<date-time> · required

data. updated_at · string<date-time> · required

data. email · string · required

data. username · string · required

data. role · enum<string> · required

Available options: SYSTEM, ADMIN, MEMBER, VIEWER

data. auth_method · string · required

Allowed value: "LOCAL"

data. password_needs_reset · boolean · required

data. password · string

next_cursor · string | null · required