v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB
Customers

List customers

Retrieve a paginated list of customers. Supports filtering by search term, country, and currency.

get/api/customers

Query parameters

pagenumber
limitnumber
searchstring

Search by name or email

countrystring
currencystring
sortBystring
sortOrder'asc' | 'desc'

Response

Paginated list of customers with metadata

Example response

{
  "data": [
    {
      "id": "clx1234567890",
      "externalId": "user_12345",
      "email": "customer@example.com",
      "name": "Jane Doe",
      "country": "US",
      "currency": "USD"
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "limit": 20,
    "totalPages": 8
  }
}