Skip to main content
GET
cURL

Users List

Requires Admin role. See Role-based access for details.

Filter an SSO workspace roster by linked status

With a workspace API token, omit org_id and pass linked=true or linked=false to filter the workspace-wide SSO roster. linked=true returns users who have an email address and at least one active linked provider account. linked=false returns users who have no email address or no active linked provider accounts. CodeRabbit applies the filter before cursor pagination. The filter is available only for workspace-wide SSO user listings; organization-scoped and non-SSO requests that include linked return 400 INVALID_REQUEST. For workspace-token examples and identity-management guidance, see SSO user management API.

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

Your CodeRabbit API key

Query Parameters

seat_filter
enum<string>
default:all

Filter users by seat assignment status

Available options:
all,
assigned,
unassigned
role_filter
enum<string>
default:all

Filter users by role

Available options:
all,
member,
admin
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

List of users with seat and subscription info

seats_purchased
integer
required

Total number of seats purchased in the subscription

seats_assigned
integer
required

Number of seats currently assigned to users

seat_assignment_mode
enum<string>
required

The seat assignment mode for the organization

Available options:
automatic,
manual
users
object[]
required
next_cursor
string | null

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