index

GET /api/v1/accounts/:account_id/customers

List or look up customers

Returns a paginated list of customers for the store. Use the search parameter to filter by name, email, phone, card code (barcode), or external reference ID. Alternatively, pass source AND external_id together to perform an exact lookup by an external reference - the response will contain at most one customer.

Parameters

Name	Type	Required	Description
`account_id`	Must be a number.	Required	Store (account) ID
`search`	Must be a String	Optional	Search query to filter customers by name, email, phone, card code (barcode), or external reference ID
`source`	Must be a String	Optional	External system slug (e.g. `square`, `shopify`). When combined with `external_id`, performs an exact lookup.
`external_id`	Must be a String	Optional	External system’s identifier for the customer. Must be combined with `source`.
`page`	Must be a number.	Optional	Page number (defaults to 1)
`items`	Must be a number.	Optional	Number of items per page

Error Codes

Code	Description
`401`	Unauthorized – invalid or missing API token
`404`	Store not found