List Customers

Use the List Customer endpoint to retrieve a list of all customers who have reached the Customer phase.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Partial match on customer reference (case-insensitive).

date

Filter by creation calendar date (YYYY-MM-DD).

date

Include customers created on or after this date (YYYY-MM-DD).

date

Include customers created on or before this date (YYYY-MM-DD).

string

Comma-separated customer statuses to include (e.g. enabled,disabled).
Each value must be a CustomerStatus enum value.
When omitted, the API defaults to enabled, disabled, and blocked (excluding deleted and unregistered).

int32

Maximum number of items to return.

int32

Pagination offset.

Headers
string
required

API key generated for client authentication.

string
required

Aggregator identifier for request ownership.

Responses

500

Internal server error

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