Get Customers
Retrieves a paginated list of customers for the specified store.
Requires the stores.customers.view permission.
Filterable Fields
This endpoint supports filtering and sorting. See the Filtering & Sorting Guide for syntax details.Authorizations
Your API key goes here
Path Parameters
The ID of the store whose customers to retrieve.
Query Parameters
Filter by dashboard segment tab (all, new, active, regulars, vip, affiliates). Uses the same classification as the /customers/filters counts endpoint. The customer segment tabs shown on the dashboard customers page. Classification mirrors the /customers/filters counts endpoint: a customer's segment is decided by their delivered order count and how recently they last ordered (14-day activity window), except Affiliates, which is an independent flag.
0, 1, 2, 3, 4, 5 Filter by email address (case-insensitive contains).
Filter by the IP address the customer used (case-insensitive contains).
Minimum balance (inclusive).
Maximum balance (inclusive).
Filter by Stripe customer ID (exact match).
Filter by the store-affiliate’s code (case-insensitive contains).
1 <= x <= 21474836471 <= x <= 2147483647Response
The object was successfully returned.
Represents a paginated response returned from API endpoints, which contains the paginated data and metadata about the pagination.