V 1 Customers Controller List

View as Markdown

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pagestringOptional

1-based page number. Defaults to 1.

pageSizestringOptional
Rows per page. Defaults to 20, capped at 100.
externalIdstringOptional

Exact match on your own identifier for the customer — returns 0 or 1 rows (the alias is unique within your company).

emailstringOptional

Exact email match. Email is NOT a customer identity — every customer sharing the address returns.

phonestringOptional

Phone in any parseable format; canonicalized to E.164 before matching. A malformed value returns 400.

Response