The blocked times
https://api.app2email.com/v1/{number}/calendar/blocks Scope: bookings:manage (or messages:read). The time blocks touching a range of days (business time zone; default 31 days from today, at most 62), soonest first. With provider_id: that staff member's blocks and the business-wide ones.
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. Default today.
e.g.2026-11-10 - to string
The last day (included). Default from + 30 days.
e.g.2026-12-10 - provider_id string
One staff member's blocks and the business-wide ones.
e.g.maria
Responses
Fields
- success boolean
- request_id string
- blocks object[]
12 item fields
- id integere.g.
3 - provider_id string
The staff member it is for. Empty: the whole business.
e.g.maria - title string
Up to 80 characters.
e.g.Lunch - notes string
Up to 500 characters.
- start string (date-time)
UTC.
- end string (date-time)
UTC.
- start_local string
Local time in the business time zone, yyyy-MM-ddTHH:mm.
e.g.2026-11-14T12:00 - end_local string
Local time in the business time zone, yyyy-MM-ddTHH:mm.
e.g.2026-11-14T13:00 - source string
Made in the calendar app, or through this API.
calendarapi - created_by string
The e-mail of the person, or API key <name>.
e.g.API key Planner - created string (date-time)
- updated string (date-time)
- count integer
- from stringe.g.
2026-11-10 - to stringe.g.
2026-12-10 - timezone string
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.