Skip to main content
GET
List customers

Query Parameters

Example Request

Response

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Query Parameters

q
string

Free-text search filter.

country
string

Filter by ISO 3166-1 alpha-2 country code.

status
enum<string>

Filter by customer status.

Available options:
active,
inactive
limit
integer
default:50

Maximum records to return. Defaults to 50 when omitted and is capped at 1000 (a larger request returns the cap, not an error). Pass an explicit limit when you need the full set — omitting it silently returns only the first page.

Required range: 1 <= x <= 1000
page
integer
default:1

1-based page number.

Required range: x >= 1

Response

Customers for the tenant.

data
object[]