Skip to main content
GET
List all users

Authorizations

X-Access-Client-Id
string
header
required

Client ID

X-Access-Secret
string
header
required

Client Access Key

Query Parameters

created_at__lte
string

Filter created_at less than or equal (ISO-8601)

created_at__gte
string

Filter created_at greater than or equal (ISO-8601)

product_type
enum<string>

Filter by product type.

Available options:
income,
employment,
deposit_switch,
pll,
insurance,
transactions,
assets
Example:

"income"

provider
string

Filter by provider id.

query
string

Search query by the following fields: id, external_user_id, email, first_name, last_name, link_id.

If not set, returns all users; otherwise, returns users with/without attempts.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

external_user_id
string

Filter by user external identifier.

When set to true, for each user adds the payload from the account links endpoint.

Response

count
integer
required
results
object[]
required
next
string<uri> | null
previous
string<uri> | null