List customers
Pages through your customers. All filters are EXACT matches: `externalId` returns at most one row (it is a per-company-unique alias — the way to look a customer up by your own id), `email` returns every customer sharing the address, and `phone` accepts any parseable format (canonicalized to E.164 before matching). `page` is 1-based; `pageSize` defaults to 20 and is capped at 100.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
page
1-based page number. Defaults to 1.
pageSize
Rows per page. Defaults to 20, capped at 100.
externalId
Exact match on your own identifier for the customer — returns 0 or 1 rows (the alias is unique within your company).
email
Exact email match. Email is NOT a customer identity — every customer sharing the address returns.
phone
Phone in any parseable format; canonicalized to E.164 before matching. A malformed value returns 400.
Response
total
Total row count after server-side filtering — drives total-page math.
page
1-based page number that produced items.
pageSize
Page size honored by the server (may be a clamp of the requested value).
items
The customers on this page.
Errors
400
Bad Request Error
401
Unauthorized Error
429
Too Many Requests Error
503
Service Unavailable Error