API referenceCustomers
List customers, with their store balance
AuthorizationBearer <token>
API key from Settings → API keys
In: header
Path Parameters
storeId*string
Query Parameters
q?string
Length
length <= 200sort?string
Default
"recent"Value in
- "recent"
- "spend"
- "orders"
account?string
Value in
- "account"
- "guest"
buyers?string
Value in
- "buyers"
- "no_orders"
page?integer
Range
1 <= value <= 9007199254740991Default
1perPage?integer
Range
1 <= value <= 200Default
25Response Body
application/json
application/json
curl -X GET "https://example.com/v1/stores/string/customers"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "string", "name": "string", "country": "string", "discordUsername": "string", "hasAccount": true, "totpEnabled": true, "marketingOptIn": true, "ordersCount": -9007199254740991, "totalSpentMinor": -9007199254740991, "spentCurrency": "string", "firstOrderAt": "string", "lastOrderAt": "string", "createdAt": "string", "balanceMinor": -9007199254740991, "balanceCurrency": "string", "balances": [ { "currency": "string", "balanceMinor": -9007199254740991 } ], "referrer": "string" } ], "pagination": { "page": -9007199254740991, "perPage": -9007199254740991, "total": -9007199254740991 }}