Skip to main content
GET
/
api
/
canary
/
customers
List Customers
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
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

merchantId
string

The ID of the merchant whose balance is being requested. If omitted, defaults to the authenticated merchant.

limit
number

Maximum number of records to return

offset
number

Number of records to skip

email
string

Filter by email address

Search across customer fields

Response

Successfully retrieved customers list

data
object[]
required
pagination
object
required