Developers

Customers

Every person who has booked with the business, or whom the business added by hand.

List customers

GET /api/v1/customers

Scope: customers:read. Newest first.

Query parameter Description
email Only the customer with exactly this address. No partial matches.
limit, offset See pagination.
curl "https://app.aphrabooking.com/api/v1/customers?email=maria@example.com" \
  -H "Authorization: Bearer $APHRA_KEY"
{
  "customers": [
    {
      "id": "c3b8e2a1-7d4f-4e9a-b1c6-5f2e8d3a9b70",
      "firstName": "Maria",
      "lastName": "Janga",
      "email": "maria@example.com",
      "phone": "+5997001234",
      "createdAt": "2026-09-02T16:40:11.004+00:00"
    }
  ],
  "limit": 50,
  "offset": 0
}

The email filter is the way to check whether someone is already a customer before you sync them into another system.

Privacy

Customer data is personal data. The business is the controller; you process it on the business’s behalf. Store only what your integration needs, and delete it when the business stops using your integration.