Skip to main content
GET
Get all Customers

Authorizations

X-API-Key
string
header
required

API Key

Headers

X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the customers will be filtered for the sub-partner

X-API-Version
string

Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01.

Query Parameters

cursor
string<uuid>

Paging: the cursor field from previous page

prev_cursor
string<uuid>

Paging: the cursor field for backward pagination

page_size
integer<uint32>
default:10

Paging: the requested page size (max 100)

Required range: x <= 100
search_term
string

A search term to filter the customers

Maximum string length: 256
status
enum<string>[]

Filter by customer status (comma-separated or repeated values)

The status of the Customer

Available options:
UserRequired,
SigningsRequired,
IdentificationRequired,
Active,
Suspended,
Archived
identification_status
enum<string>[]

Filter by the customer's most-recent identification status

The Process status of the identification

The various state transitions an identification can go through.

Available options:
Pending,
Processed,
PendingReview,
Approved,
Declined,
Expired,
Archived
customer_type
enum<string>[]

Filter by customer type (Person or Business)

CustomerType

Customers can either be a commercial business or a natural person

Available options:
Business,
Person
has_transactions
boolean

When true, only customers with at least one transaction; when false, only customers without any. Omit to disable the filter.

sort_order
enum<string>

Sort order: "asc" for oldest first, "desc" for newest first (default)

Available options:
asc,
desc

Response

GET ALL Customer Succeeded

PagedList

A list of items with cursors used to fetch the next or previous page

items
Customer · object[]
required

The list of items

cursor
string<uuid>

The cursor used to fetch the next page

prev_cursor
string<uuid>

The cursor used to fetch the previous page