Get customers

Retrieve a paginated list of customers with optional filters.

GET/v1/customers

Query Parameters

Page number (1-based)

Number of items per page

Filter by exact email address

Sort order (e.g. created_at ASC or created_at DESC)

Filter by customer status (e.g. active)

Filter by customer type

Possible values: individual, business

Full-text search across first name, last name, email, and customer ID

Filter by KYC status of the customer's basic KYC record

Offset — number of records to skip before the current page

Upper record offset bound

Status	Description
`200`	Paginated list of customers
`400`	Bad request — invalid or missing parameters

Possible values: individual, business

Possible values: male, female, other

{
"data": null,
"error": "invalid request body"
}

Was this page helpful?