List User Identities

get

https://example.com/v1/admin/users/identities

Get a list of user identities, narrowed by the supplied filters and search term.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

length ≥ 1

\S

Text the name, first name, last name, username or email must contain, matched
case-insensitively, matching every user when omitted. A term of one or two characters must
equal the whole value instead.

name

array of strings

length between 1 and 200

Names to return, as first and last name joined by a space, matching any one of them
exactly, returning every user when omitted.

name

username

array of strings

length between 1 and 200

Usernames to return, matching any one of them exactly, returning every user when omitted.

username

array of strings

length between 1 and 200

Email addresses to return, matching any one of them exactly, returning every user when
omitted.

phone

array of strings

length between 1 and 200

Phone numbers to return, matching any one of them exactly, returning every user when
omitted.

phone

tax_id

array of strings

length between 1 and 200

Tax IDs to return, matching any one of them exactly, returning every user when omitted.

tax_id

sort_by

string

enum

Allowed:

sort_dir

string

enum

Direction to order the results in, descending when omitted.

Allowed:

page

integer

0 to 4294967295

Page number for paginated results.

page_size

integer

0 to 4294967295

Page size for paginated results.

Responses

400

search term must not be blank

The query string is missing a required parameter, or a parameter could not be parsed into its expected type.

401

Not authenticated

500

database error

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK