List customers
Customers
List customers
Retrieve a paginated, searchable list of the store’s customers. Requires the READ_CUSTOMERS scope.
GET
List customers
Returns the store’s customers sorted by most recent activity, with optional free-text search across name, email and phone. The store is bound to your app token server-side — never send a shop id.
Device & location info (
READ_CUSTOMER_ANALYTICS). With only READ_CUSTOMERS each customer
returns name, email, phone and activity. If your installation also holds READ_CUSTOMER_ANALYTICS,
each customer’s user.deviceInfo is included — device, browser, OS, IP address, approximate
location (ipInfo) and a device fingerprint. This is sensitive shopper PII; request the scope only
if you need it.Authorizations
Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.
Query Parameters
1-based page number.
Required range:
x >= 1Items per page. Defaults to 10, capped at 100.
Required range:
1 <= x <= 100Case-insensitive substring match against customer name, email or phone.
Response
Paginated list of customers.
Standard Salesive response envelope. The operation-specific payload is carried in data.

