Search identities.

Returns a paginated list of identities filtered by identity columns or metadata buckets.
Filters use the filter[<source>.<path>] syntax where source is identity, public, or admin.
The filter[query] parameter enables a configurable "universal search" across multiple fields (operator: contains).
Predicates are specified as <operator>:<value>.
Supported operators: eq, neq, in, lt, le, ge, startswith, endswith, contains, null, notnull.
The endpoint expects a session token either in "Authorization Bearer" or the configured session cookie.
Provide the X-IRS-CSRF-Token header when the session cookie is used.

Query Params
integer

Page size (default 50, maximum 200)

integer

1-based page number (default 1)

string

Universal search query using : (example: 'contains:john doe')

string

Filter identity columns using : (example: 'eq:active')

string

Filter identity types using eq: or in:<type1,type2>

string

Filter public metadata using : or in: list predicates

string

Filter admin metadata using : or in: list predicates

string

Filter identity identifiers (email, phone, etc.) using the same operators as identity fields

string

Sorting instructions, e.g. '-identity.createdAt'; multiple sorts comma separated

Headers
string

Session token provided in Authorization Bearer

string
string

CSRF Token

Responses

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