Customers
List customers
GET
Lists the store's customers, newest first, with contact details and marketing status. Filter by exact email or date.
apiKeyheader
AuthorizationBearer <token>A store API key from Settings → Developers → API keys, sent as Authorization: Bearer zk_live_….
limit?integerPage size, 1–100
Range
1 <= value <= 100Default
25cursor?stringnext_cursor from the previous page
Length
length <= 500order?stringSort by created_at; newest first by default
Default
"desc"Value in
"desc""asc"created_after?stringOnly records created after this time
Format
date-timecreated_before?stringOnly records created before this time
Format
date-timeupdated_after?stringOnly records changed after this time — poll with your last sync time
Format
date-timeupdated_before?stringOnly records changed before this time
Format
date-timeemail?stringExact email match
Format
emailSuccess
application/json- response
object*"list"Value in
"list"data*array<>has_more*booleanWhether another page exists
next_cursor*stringPass as cursor to get the next page; null on the last
curl -X GET "https://example.com/customers"{ "object": "list", "data": [ { "object": "customer", "id": "00000000-0000-4000-8000-0000000000c1", "name": "Sara Ahmed", "email": "sara@example.com", "phone": "+966500000000", "source": "checkout", "email_status": "valid", "unsubscribed_at": null, "tags": [ "vip" ], "created_at": "2026-09-12T14:20:00.000Z", "updated_at": "2026-10-01T09:30:00.000Z" } ], "has_more": false, "next_cursor": null}