List Users

Returns a list of all users.

This endpoint is typically used to enumerate all users. It can also be used with filtering query params to return a single user (or a few). Examples of the latter are filtering on a primary_email, external_identifier or filtering on metadata.

Filtered results

Note that when filtering the data is still returned as an array, but assuming unique values, you can expect a single record (or empty list if no matching users were found).

Query Params
string

Filter user list on primary email.

string

Filter user list on external_identifier.

external_metadata
object

Filter user list on external_metadata values.

string

Pagination cursor

string

Pagination cursor

Response

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