List all users in the organization

curl --request GET \
  --url https://api.coderabbit.ai/v1/users \
  --header 'x-coderabbitai-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};

fetch('https://api.coderabbit.ai/v1/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "seats_purchased": 50,
  "seats_assigned": 30,
  "seat_assignment_mode": "manual",
  "users": [
    {
      "user_id": "121358802",
      "username": "janedoe",
      "seat_assigned": true,
      "role": "6f1bb6c1-4766-4f09-9d0d-b998c33d2398",
      "role_name": "Security Reviewer",
      "role_type": "custom"
    }
  ],
  "next_cursor": "MTIxMzU4ODAy"
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid seat_filter. Must be one of: \"all\", \"assigned\", \"unassigned\" OR Invalid role_filter. Must be one of: \"all\", \"member\", \"admin\""
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or inactive API key"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "User does not have the required permissions"
  }
}

{
  "error": {
    "code": "LEGACY_API_KEY",
    "message": "You are using a legacy API key. We are deprecating use of legacy keys. Regenerate a new API key and retry the request."
  }
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Max 10 requests per 60 seconds"
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error while listing users"
  }
}

GET

users

List all users in the organization

curl --request GET \
  --url https://api.coderabbit.ai/v1/users \
  --header 'x-coderabbitai-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};

fetch('https://api.coderabbit.ai/v1/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "seats_purchased": 50,
  "seats_assigned": 30,
  "seat_assignment_mode": "manual",
  "users": [
    {
      "user_id": "121358802",
      "username": "janedoe",
      "seat_assigned": true,
      "role": "6f1bb6c1-4766-4f09-9d0d-b998c33d2398",
      "role_name": "Security Reviewer",
      "role_type": "custom"
    }
  ],
  "next_cursor": "MTIxMzU4ODAy"
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid seat_filter. Must be one of: \"all\", \"assigned\", \"unassigned\" OR Invalid role_filter. Must be one of: \"all\", \"member\", \"admin\""
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or inactive API key"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "User does not have the required permissions"
  }
}

{
  "error": {
    "code": "LEGACY_API_KEY",
    "message": "You are using a legacy API key. We are deprecating use of legacy keys. Regenerate a new API key and retry the request."
  }
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Max 10 requests per 60 seconds"
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error while listing users"
  }
}

CLI Tool
MCP Server

coderabbit api request /users

To install and sign in to the CLI, see Call from the CLI.

Authorizations

x-coderabbitai-api-key

string

header

required

See Authentication for the key types and where to create a key.

Query Parameters

org_name

string

GitHub organization login for a workspace API key, matched case-insensitively within that workspace. Supply either org_name or org_id, never both; omit for an organization-bound key.

Pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$

org_id

string

Workspace-scoped API tokens only. Supply this git-provider organization ID or org_name, never both, to list one organization's users. When both selectors are omitted, returns a workspace-wide, person-centric view across all organizations in the workspace. This org_id parameter is ignored for organization and self-hosted keys.

seat_filter

enum<string>

default:all

Filter users by seat assignment status. Options are "all" (default), "assigned" (users with seats), or "unassigned" (users without seats).

Available options:

all,

assigned,

unassigned

role_filter

enum<string>

default:all

Filter users by system role. Options are "all" (default), "member" (cr_member role only), or "admin" (cr_admin role only).

Available options:

all,

member,

admin

role_id_filter

string

Filter users by an exact role ID. Use cr_admin, cr_member, or a custom role UUID.

membership

enum<string>

default:org

Filter users by workspace-org membership. "org" (default) returns only members of a workspace org, hiding external contributors (e.g. authors of pull requests on public repositories); "non_org" returns only those external contributors; "all" returns everyone.

Available options:

org,

non_org,

all

linked

boolean

Workspace-wide SSO user rosters only; omit both org_id and org_name. When true, returns users with a non-null email and at least one active linked account. When false, returns users whose email is null or who have no active linked accounts. Supplying this parameter for an organization-scoped or non-SSO read returns 400.

string<email>

Workspace-wide SSO rosters only (workspace token, omit both org_id and org_name). Exact case-insensitive member email match, with surrounding whitespace trimmed. Mutually exclusive with username. Applied before pagination and combined with seat_filter, linked, and membership; seat totals remain workspace-wide. Workspace reads do not apply role_filter or role_id_filter.

username

string

Workspace-wide SSO rosters only (workspace token, omit both org_id and org_name). Exact case-insensitive linked username match, with surrounding whitespace trimmed, across all cloud providers and self-hosted instances. Only non-removed identities in active workspace subscriptions match. Returns each matching person once with all their linked accounts; multiple people may match. Mutually exclusive with email. Applied before pagination. Repeat the lookup parameters on subsequent pages.

Minimum string length: 1

limit

integer

default:100

Maximum number of users to return per page.

Required range: 1 <= x <= 100

cursor

string

Pagination cursor from previous response's next_cursor field.

Response

Successfully retrieved list of users

seats_purchased

integer

required

Total number of seats purchased in the subscription

Example:

50

seats_assigned

integer

required

Number of assigned seats. For SSO, this counts paid canonical workspace members, deduplicated across provider identities and excluding trial-only funding. It is independent of organization, filters and pagination, and can differ from the number of assigned identities in users.

Example:

30

seat_assignment_mode

enum<string>

required

The seat assignment mode for the organization

Available options:

automatic,

manual

Example:

"manual"

users

(Org-scoped (organization, self-hosted, org-selected workspace tokens) · object | Workspace person-centric (workspace tokens, neither org_id nor org_name) · object)[]

required

Item shape depends on the token scope. Organization, self-hosted, and org-selected workspace tokens (org_id or org_name present) return the org-scoped object. Workspace-scoped tokens with neither selector return the workspace-wide, person-centric object.

Org-scoped (organization, self-hosted, org-selected workspace tokens)
Workspace person-centric (workspace tokens, neither org_id nor org_name)

Show child attributes

next_cursor

string | null

required

Cursor for the next page of results, or null if no more results

Example:

"MTIxMzU4ODAy"

Basics

Clients

Guides

API reference

List all users in the organization

Authorizations

Query Parameters

Response