List users

Returns org members matching the supplied filters. Filters are combined with AND across fields and ANY within each field's values. At least one filter must be set, or list_all must be true.

Use this endpoint to retrieve the users (organization members) that match the filters you provide, such as username, user ID, seat type, status, or system user field. Your organization is determined by your API token.

Filter options

Provide at least one filter to narrow your results, or set list_all to true to retrieve every user.

  • AND across fields: When you combine different filters (for example, a seat type and a user field), the API returns only the users that match all of them.
  • ANY within a field: When you provide multiple values for one filter (for example, two usernames), the API returns the users that match any of those values.

Requirements

Limitations

  • Filters match exactly. Partial, fuzzy, and wildcard searches are not supported.
  • You can filter system user fields only. Custom user fields are not yet supported.
  • You cannot filter by group or site membership.
Body Params

ListUsersRequest contains the parameters for listing users within the caller's org.
The organization is derived from the caller's JWT token.
Results are sorted by user_id ascending. No other sort order is supported in v1.

ListUsersRequest contains the parameters for listing users within the caller's org.
The organization is derived from the caller's JWT token.
Results are sorted by user_id ascending. No other sort order is supported in v1.

filters
object

ListUsersFilters holds all filter criteria for a ListUsers request.
Filters across different fields are combined with AND.
An empty ListUsersFilters with list_all = true returns all active org users.

boolean

Set to true to return all active users in the org with no filter applied.
Required when filters is empty or absent. Prevents accidental full org scans.

int32

Maximum number of users to return per page. Range: 1–200. Defaults to 50.

string

Opaque pagination cursor returned by a previous ListUsers response.
Omit to start from the beginning.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json