Users

List all users

get

Retrieve a paginated list of all users in the system.

Query parameters

cursorstringOptional

Cursor for pagination (base64-encoded user ID)

limitintegerOptional

The max number of users to return at a time.

Default: 100

Responses

200

A list of users.

application/json

403

Forbidden

text/plain

422

Unprocessable Entity

text/plain

get

HTTPcURLJavaScriptPython

GET /v1/users HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "id": "text",
      "created_at": "2025-06-05T01:16:57.340Z",
      "updated_at": "2025-06-05T01:16:57.340Z",
      "email": "text",
      "username": "text",
      "role": "SYSTEM",
      "auth_method": "text",
      "password": "text",
      "password_needs_reset": true
    }
  ],
  "next_cursor": "text"
}

Delete a user by ID

delete

Delete an existing user by their unique GlobalID.

Path parameters

user_idstringRequired

The GlobalID of the user (e.g. 'VXNlcjox').

Responses

204

No content returned on successful deletion.

403

Cannot delete the default admin or system user

text/plain

404

User not found.

text/plain

422

Unprocessable Entity

text/plain

delete

HTTPcURLJavaScriptPython

DELETE /v1/users/{user_id} HTTP/1.1
Host: 
Accept: */*

No content

Create a new user

post

Create a new user with the specified configuration.

Body

userone ofRequired

or

send_welcome_emailbooleanOptionalDefault: true

Responses

201

The newly created user.

application/json

400

Role not found.

text/plain

403

Forbidden

text/plain

409

Username or email already exists.

text/plain

422

Unprocessable Entity

text/plain

post

HTTPcURLJavaScriptPython

POST /v1/users HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "user": {
    "email": "text",
    "username": "text",
    "role": "SYSTEM",
    "auth_method": "text",
    "password": "text"
  },
  "send_welcome_email": true
}

{
  "data": {
    "id": "text",
    "created_at": "2025-06-05T01:16:57.340Z",
    "updated_at": "2025-06-05T01:16:57.340Z",
    "email": "text",
    "username": "text",
    "role": "SYSTEM",
    "auth_method": "text",
    "password": "text",
    "password_needs_reset": true
  }
}