Skip to main content
GET
List all users in the organization

Authorizations

x-coderabbitai-api-key
string
header
required

API key for authentication. You can create an API key from the CodeRabbit dashboard.

Headers

x-coderabbitai-api-key
string
required

API key for authentication

Query Parameters

org_id
string

Workspace-scoped API tokens only. When provided, lists users for that single git-provider organization within the token's workspace; when omitted, returns a workspace-wide, person-centric view across all organizations in the workspace. 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. 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.

email
string<email>

Workspace-wide SSO rosters only (workspace token, omit org_id). 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 org_id). 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 seats currently assigned to 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, no org_id) · object)[]
required

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

next_cursor
string | null
required

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

Example:

"MTIxMzU4ODAy"