API Reference
Log In
API Reference

/users

Retrieves a paginated list of users.

Filters

ParameterDescription
emails[]Filters users by one or more email addresses
usernames[]Filters users by one or more usernames
ids[]Filters users by one or more IDs
onlyActiveIf true or not provided, only active users will be returned. If false, all users will be returned.

Multiple values for the same filter match any of the provided values. For example, emails[][email protected]&emails[][email protected] returns users with either email.

Different filter types are combined with AND. For example, emails[][email protected]&usernames[]=username-123 only returns users where both the email AND username match the same user.

If no filters are provided, all users will be returned in a paginated format.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
emails[]
array of strings

Optional list of email addresses

emails[]
usernames[]
array of strings

Optional list of usernames

usernames[]
ids[]
array of strings

Optional list of user IDs

ids[]
boolean

Whether to return only active users or all users

number

The maximum number of items to return. Must be a positive number and not greater than 100. Default 10.

number

The number of items to skip. Must be a positive number or 0. Default 0.

Responses

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