List customers
Lists customers with search and pagination. Returns only essential fields: id, createdAt, name, phone, email, and latestPaymentMethod. Search supports customer ID, name, email, or phone (supports comma-separated terms).
Lists customers with search and pagination. Returns only essential fields: id, createdAt, name, phone, email, and latestPaymentMethod. Search supports customer ID, name, email, or phone (supports comma-separated terms).
Authorization
api-key API key for merchant integrations. Send as Authorization: Bearer <your key>.
In: header
Query Parameters
Filter by customer type: registered (merchant-created) or guest (auto-created during checkout)
"registered" | "guest"Search by customer ID, name, email, or phone (supports comma-separated terms)
Number of items per page
1 <= value <= 100Page number (1-based)
1 <= valueResponse Body
application/json
curl -X GET "https://example.com/customers"{
"data": [
{
"id": "cus_abc123",
"type": "registered",
"createdAt": "2024-01-01T00:00:00.000Z",
"name": "John Doe",
"email": "john@example.com",
"phone": "+201234567890",
"country": "EG",
"latestPaymentMethod": {
"card": {},
"valu": {}
},
"spendData": {}
}
],
"totalCount": 42
}