List users

POST

users

get

curl --request POST \
  --url https://{host}/v1/users/get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "org_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f"
}
'

{
  "ok": true,
  "data": {
    "users": [
      {
        "id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
        "username": "jdoe",
        "display_name": "Jane Doe",
        "email": "[email protected]",
        "role": "user",
        "suspended_at": null,
        "suspended_reason": null,
        "created_at": "2026-10-07T10:00:00Z"
      }
    ],
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}

{
  "ok": false,
  "error": "sort_by applies to the site-admin hub list only (not with org_id / realm_id)",
  "code": "invalid_params"
}

{
  "ok": false,
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

{
  "ok": false,
  "error": {
    "code": "forbidden",
    "message": "You do not have access to do this"
  }
}

{
  "ok": false,
  "error": "org_id: Required",
  "code": "invalid_params"
}

{
  "ok": false,
  "error": "Internal server error",
  "code": "internal_error"
}

Authorizations

Authorization

string

header

required

User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).

Body

application/json

org_id

string<uuid>

The organization whose members to list.

realm_id

string

List people who are not yet members of this realm (for inviting them).

Minimum string length: 1

query

string

Matches part of the username or email.

string

Older name for query.

role

enum<string>

Site administrators: only user or admin accounts.

Available options:

user,

admin

suspended

boolean

Site administrators: only suspended (true) or active (false) accounts.

limit

integer

Page size (at most 100).

Required range: 1 <= x <= 100

offset

integer

Rows to skip, for paging.

Required range: x >= 0

sort_by

enum<string>

Site-admin hub list only (400 with org_id / realm_id).

Available options:

username,

role,

created_at,

suspended_at

sort_dir

enum<string>

Sort direction with sort_by (default asc); ties are broken by id ascending

Available options:

asc,

desc

include_deleted

boolean

Site administrators: also list deleted accounts.

Response

Success.

enum<boolean>

required

Always true on success.

Available options:

true

data

object

required

Show child attributes

curl --request POST \
  --url https://{host}/v1/users/get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "org_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f"
}
'

{
  "ok": true,
  "data": {
    "users": [
      {
        "id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
        "username": "jdoe",
        "display_name": "Jane Doe",
        "email": "[email protected]",
        "role": "user",
        "suspended_at": null,
        "suspended_reason": null,
        "created_at": "2026-10-07T10:00:00Z"
      }
    ],
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}

{
  "ok": false,
  "error": "sort_by applies to the site-admin hub list only (not with org_id / realm_id)",
  "code": "invalid_params"
}

{
  "ok": false,
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

{
  "ok": false,
  "error": {
    "code": "forbidden",
    "message": "You do not have access to do this"
  }
}

{
  "ok": false,
  "error": "org_id: Required",
  "code": "invalid_params"
}

{
  "ok": false,
  "error": "Internal server error",
  "code": "internal_error"
}

Introduction

System

Auth

Users

Organizations

Invitations

Teams

Realms

Daemons

Workspaces

Runs

Artifacts

Events

Reviews

Notification channels

Notifications

Agents

Settings

Mesh

Jira

A2A

Authorizations

Body

Response