v1
latestOpenAPI 3.0.42026-07-2685196386.6 KBCustomer
Search customers
Retrieves a paginated list of customers for the specified store, matching the provided query. Requires the stores.customers.view permission.
get/stores/{storeId}/customers/search/{query}
Path parameters
querystring required
The query to search by
storeIdstring uuid required
The ID of the store whose customers to retrieve.
Query parameters
emailstring
Filter by email address (case-insensitive contains).
ipAddressstring
Filter by the IP address the customer used (case-insensitive contains).
balanceFromnumber double
Minimum balance (inclusive).
balanceTonumber double
Maximum balance (inclusive).
stripeCustomerIdstring
Filter by Stripe customer ID (exact match).
affiliateCodestring
Filter by the store-affiliate’s code (case-insensitive contains).
Filtersstring
Sortsstring
Pageinteger
PageSizeinteger
Response
The object was successfully returned.