List Customers
Customers
List Customers
List customers with full filter support, returning a paginated envelope.
Response shape: {items: [...], total: N, total_capped: bool, page: N, page_size: N}.
KPI counters use GET /customers/kpis/summary; the list total is capped at
10,000 (total_capped=true).
GET
List Customers
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Batch lookup: return only customers whose id is in this set (repeat the param). Lets the CRM resolve many customer names in a single scoped call instead of one GET /customers/{id} per row.
If true, return only customers with no owner (owner_id IS NULL)
contains match
contains match
organic / affiliate / import / promo
contains match
Required range:
x >= 1Required range:
1 <= x <= 500Response
Successful Response