Users

List Users

get

Returns a list of all users.

Args: user_filter_model: Model that takes care of filtering, sorting and pagination. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response. auth_context: Authentication context.

Returns: A list of all users.

Authorizations

OAuth2passwordRequired

Token URL:

Query parameters

hydratebooleanOptionalDefault: false

sort_bystringOptionalDefault: created

logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:

pageinteger · min: 1OptionalDefault: 1

sizeinteger · min: 1 · max: 10000OptionalDefault: 20

idany of · nullableOptional

string · uuidOptional

or

stringOptional

or

createdany of · nullableOptional

string · date-timeOptional

or

stringOptional

or

updatedany of · nullableOptional

string · date-timeOptional

or

stringOptional

or

nameany of · nullableOptional

stringOptional

or

string[]Optional

full_nameany of · nullableOptional

stringOptional

or

string[]Optional

emailany of · nullableOptional

stringOptional

or

string[]Optional

activeany of · nullableOptional

booleanOptional

or

stringOptional

email_opted_inany of · nullableOptional

booleanOptional

or

stringOptional

external_user_idany of · nullableOptional

string · uuidOptional

or

stringOptional

or

Responses

200

Successful Response

application/json

indexintegerRequired

max_sizeintegerRequired

total_pagesintegerRequired

totalintegerRequired

401

Unauthorized

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

get/api/v1/users

GET /api/v1/users HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2026-01-01T00:00:00.000Z",
        "updated": "2026-01-01T00:00:00.000Z",
        "active": false,
        "activation_token": "text",
        "full_name": "",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
        "avatar_url": "text"
      },
      "metadata": {
        "password_changed_at": "2026-01-01T00:00:00.000Z",
        "email": "",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    }
  ]
}

Get User

get

Returns a specific user.

Args: user_name_or_id: Name or ID of the user. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response. auth_context: Authentication context.

Returns: A specific user.

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

user_name_or_idany ofRequired

stringOptional

or

string · uuidOptional

Query parameters

hydratebooleanOptionalDefault: true

Responses

200

Successful Response

application/json

Response model for user and service accounts.

This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.

idstring · uuidRequired

permission_deniedbooleanOptionalDefault: false

namestring · max: 255Required

401

Unauthorized

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

get/api/v1/users/{user_name_or_id}

GET /api/v1/users/{user_name_or_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "body": {
    "created": "2026-01-01T00:00:00.000Z",
    "updated": "2026-01-01T00:00:00.000Z",
    "active": false,
    "activation_token": "text",
    "full_name": "",
    "email_opted_in": true,
    "is_service_account": true,
    "is_admin": true,
    "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
    "avatar_url": "text"
  },
  "metadata": {
    "password_changed_at": "2026-01-01T00:00:00.000Z",
    "email": "",
    "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": false,
  "name": "text"
}