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 AuthorizationBearer <token>
API key for merchant integrations. Send as Authorization: Bearer <your key>.
In: header
Query Parameters
page?|
Range
1 <= value <= 2147483647Default
1limit?|
Range
1 <= value <= 100Default
20search?string|null
type?|
Value in
- "registered"
- "guest"
Response Body
application/json
application/json
application/json
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": {}, "spendData": {} } ], "totalCount": 42}