Search Users

Search Users in the current organization with applicable filters.

Supports two pagination methods. Cursor-based (cursor/limit) is stable and performant on large
datasets; it is triggered automatically when a cursor value is provided, and cursor and offset
cannot be combined. Offset-based (offset/limit) is also supported. Both methods return a
metadata object with a next_cursor field — pass it back as cursor to fetch the next page; when
next_cursor is null, there are no more results. Filters are not encoded in the cursor, so include them
on every request.

Params/Filters for searching users are:

  • name - search by name, case insensitive, partial match
  • email - search by email, case insensitive, complete match
  • phone - search by phone number, complete match
  • role - search by role, case insensitive, complete match
  • state - search by state, case insensitive, complete match
  • limit - sets the number of records to return
  • cursor - cursor for keyset pagination (use the next_cursor from the previous response)
  • offset - sets the number of records to skip (cannot be combined with cursor)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Search User Params

Parameters for searching and filtering users.

string

Cursor for keyset pagination. Use the next_cursor value from the previous response.

string

User's email address

integer
Defaults to 50

Number of results to return

string

User's name

integer
Defaults to 0

Number of results to skip. Cannot be combined with cursor.

string

User's phone number

string

User's role in the system

string

User's account state

Responses

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