The customers with appointments
https://api.app2email.com/v1/{number}/bookings/customers Scope: bookings:manage (or messages:read). The people who have appointments, newest activity first, with visits, no-shows, upcoming count, packages left and the total paid. q searches name, e-mail and number; tag filters by a contact tag. Page with next_cursor.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Query
- q string
Name, e-mail or number contains this.
e.g.smith - tag string
Only contacts with this tag.
e.g.vip - sort string
recent (default), name or visits.
recentnamevisits -
How many (1 to 200, default 50).
- cursor string
The next_cursor of the previous answer, unchanged. Leave out for the first page.
Responses
Fields
- success boolean
- request_id string
- customers object[]
11 item fields
- contact stringe.g.
61412345678 - name string
- email string
- visits integer
- no_shows integer
- upcoming integer
- last_visit string (date-time) | null
- next_start string (date-time) | null
- packages_left integer
- total_paid_label stringe.g.
$120.00
- count integer
- next_cursor string
Pass it as cursor for the next page. Left out on the last page.
Errors
- 400 The request is malformed (missing or invalid fields, query parameters or times).
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.