index
GET
/api/v1/accounts/:account_id/customers
List customers
Returns a paginated list of customers for the store. Use the search parameter to filter by name, email, phone, or card code (barcode). The response includes pagination metadata.
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, or card code (barcode) |
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 |