Everything on the calendar for a range of days
https://api.app2email.com/v1/{number}/calendar Scope: bookings:manage (or messages:read). One feed for a range of days (business time zone; default 7 days from today, at most 62): the appointments, the blocked time, the busy time of the connected calendar (our own appointments left out) and the times held right now, each with start/end in UTC and start_local/end_local; plus the opening hours per day (overrides applied), the staff and the services. include picks any of bookings,blocks,busy,holds; cancelled appointments only with cancelled=true.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Query
- from string
The first day, YYYY-MM-DD in the business time zone. Default today.
e.g.2026-11-10 - to string
The last day (included). Default from + 6 days; at most 62 days.
e.g.2026-11-16 - provider_id string
Only this staff member's entries (and the business-wide ones). Left out: everyone.
e.g.maria - include string
Comma list of bookings, blocks, busy, holds. Default: all four.
e.g.bookings,blocks -
true: also the cancelled appointments.
Responses
Fields
- success boolean
- request_id string
- timezone stringe.g.
Australia/Sydney - from stringe.g.
2026-11-10 - to stringe.g.
2026-11-16 - now_local stringe.g.
2026-11-11T10:42 - enabled boolean
Book-and-Pay is switched on.
- web object
The online booking page.
-
The business's open windows per day, overrides applied: {"2026-11-10": [["09:00", "17:00"]]}. [] = closed.
- providers object[]
The staff: id, name, enabled, services, hours per day. Empty when the number has no staff.
- services object[]
id, name, duration_min, price, description, enabled.
- events object[]
15 item fields
- kind string
bookingblockbusyhold - id integer
kind booking and block.
- reference string
kind booking and hold.
- status string
kind booking.
confirmedcancelledcompletedno_show - start string (date-time)
UTC.
- end string (date-time)
UTC.
- start_local string
Local time in the business time zone, yyyy-MM-ddTHH:mm.
- end_local string
Local time in the business time zone, yyyy-MM-ddTHH:mm.
- provider_id string
- title string
kind block and busy.
- service_id string
- service_name string
- contact string
- contact_name string
- notes_count integer
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.