Skip to main content
GET
List Users

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

includeDeactivated
boolean

Whether to include deactivated users in the response.

pageSize
integer<int32>

Maximum number of results to return. Default is 10000, maximum is 10000.

pageToken
string

Token for pagination. Leave empty for the first request.

emails
string[]

Return only the users with these email addresses, matched exactly and case-insensitively. Repeat the parameter to resolve a batch (?emails=a@corp.com&emails=b@corp.com), up to 1000 per request. Addresses that match no user are simply absent from the response. Combines with include_deactivated: a deactivated user matches only when include_deactivated is true.

Response

200 - application/json

Success

data
User · object[]

The list of users.

nextPageToken
string | null

Token for retrieving the next page of results. Empty if no more results.