List Customers
Customers
List Customers
Retrieve a paginated customer directory from vendor order data
GET
List Customers
V2 Alpha — This endpoint is part of the V2 API preview. Breaking changes may occur.
Overview
Retrieve a paginated list of unique customers derived from the authenticated vendor’s order data. Each customer record includes contact information, order count, total spent, and the date of their last order.Vendor Token Required — This endpoint requires a vendor-scoped JWT token. Merchant tokens will receive a 403 error.
Use Cases
- Build a vendor CRM showing customer purchase history
- Identify high-value customers by total spend or order frequency
Query Parameters
string
Filter by first order date (minimum, ISO 8601).
string
Filter by first order date (maximum, ISO 8601).
string
Filter by Shopify location ID.
string
Search in customer email, first name, or last name.
integer
Number of items to return, forward pagination (1-100).
string
Cursor for forward pagination.
integer
Number of items to return, backward pagination (1-100).
string
Cursor for backward pagination.
Response
200