curl --request GET \
--url https://api.cashful.africa/api/canary/customers \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "customer_789",
"merchantId": "merchant_456",
"phoneNumber": "+27821234567",
"email": "john.doe@example.com",
"name": "John Doe",
"metadata": {
"source": "web",
"referralCode": "FRIEND123"
},
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}
],
"pagination": {
"limit": 50,
"offset": 0,
"total": 150,
"hasMore": true
}
}Retrieves a paginated list of all customers for the merchant
curl --request GET \
--url https://api.cashful.africa/api/canary/customers \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "customer_789",
"merchantId": "merchant_456",
"phoneNumber": "+27821234567",
"email": "john.doe@example.com",
"name": "John Doe",
"metadata": {
"source": "web",
"referralCode": "FRIEND123"
},
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}
],
"pagination": {
"limit": 50,
"offset": 0,
"total": 150,
"hasMore": true
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The ID of the merchant whose balance is being requested. If omitted, defaults to the authenticated merchant.
Maximum number of records to return
Number of records to skip
Filter by email address
Search across customer fields