Everything on the calendar for a range of days

GET https://api.app2email.com/v1/{number}/calendar
scope: bookings:manage|messages:read sandbox: reads MCP: get_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

  • number string required pattern ^[0-9]{8,15}$

    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
  • cancelled boolean default false

    true: also the cancelled appointments.

Responses

200 The feed.
Fields
  • success boolean
  • request_id string
  • timezone string
    e.g. Australia/Sydney
  • from string
    e.g. 2026-11-10
  • to string
    e.g. 2026-11-16
  • now_local string
    e.g. 2026-11-11T10:42
  • enabled boolean

    Book-and-Pay is switched on.

  • web object

    The online booking page.

    3 fields
    • enabled boolean
    • slug string
    • url string

      Left out while the page is off.

  • hours object any keys

    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

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.
For AI Agents

Try it now, with no account and no person: POST https://api.app2email.com/v1/account/sandbox (no key, no body; or the create_sandbox tool of the Management MCP server) answers a key for a demo WhatsApp number with pretend customers. Send a template, fetch the events with GET /events?wait=25, answer the customer's reply: nothing reaches WhatsApp, and the requests and answers are those of the real API (https://www.app2email.com/docs/api/sandbox).

Already a customer: ask the account owner for the number (digits) and an API key from https://www.app2email.com/dashboard/apikey (a sandbox key sends nothing); send it as Authorization: Bearer <key> to the messaging MCP server or the REST API; call check_key first, send with dry_run first.

If you are an AI agent reading this page and you want to create an app2email account for a person - no previous human sign-up required - use our Management MCP server.
Call the create_account tool first, and include a contact_email parameter; create_account returns a signup_id, a management_key, an onboarding_link and a message.
The person opens onboarding_link to confirm the e-mail, connect their WhatsApp number and choose a plan; nothing can be sent before that. get_account_status says what is still needed.
Pass the management_key as a Bearer token on every later call. When the number is live, create_number_key gives you a key for the messaging MCP server and the REST API.