Skip to main content
GET
List Users

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

status
enum<string>

Filter by user status.

Available options:
active,
invited,
deactivated
scim_managed
boolean

true to return only SCIM-provisioned users. false to return only API-created users. Omit to return all users.

role_id
string<uuid>

Filter to users who hold a specific role (direct or group-derived).

email
string

Exact match filter on email address.

limit
integer
default:20

Maximum number of results to return per page.

Required range: x <= 100
cursor
string

Pagination cursor from next_cursor in the previous response. Omit to start from the beginning.

Response

200 - application/json

OK

limit
integer

Maximum number of items per page as requested.

next_cursor
string | null

Pagination cursor for the next page. null when no further pages exist. Total count is not returned.

items
object[]