Skip to main content
GET
Get customers

Filterable Fields

This endpoint supports filtering and sorting. See the Filtering & Sorting Guide for syntax details. Example:

Authorizations

Authorization
string
header
required

Your API key goes here

Path Parameters

storeId
string<uuid>
required

The ID of the store whose customers to retrieve.

Query Parameters

segment
enum<integer>

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.

Available options:
0,
1,
2,
3,
4,
5
email
string

Filter by email address (case-insensitive contains).

ipAddress
string

Filter by the IP address the customer used (case-insensitive contains).

balanceFrom
number<double>

Minimum balance (inclusive).

balanceTo
number<double>

Maximum balance (inclusive).

stripeCustomerId
string

Filter by Stripe customer ID (exact match).

affiliateCode
string

Filter by the store-affiliate’s code (case-insensitive contains).

Filters
string
Sorts
string
Page
integer<int32>
Required range: 1 <= x <= 2147483647
PageSize
integer<int32>
Required range: 1 <= x <= 2147483647

Response

The object was successfully returned.

Represents a paginated response returned from API endpoints, which contains the paginated data and metadata about the pagination.

success
boolean
required
read-only

Indicates whether the operation was successful

pages
integer<int32>
required

The total number of pages available in the paginated response.

data
object[]
required

Represents the collection of items within a paginated response

Last modified on November 27, 2025