Skip to main content

​
Welcome

The Vapify Calendar API is designed for AI agents, automation tools, and external systems that need to work with a subaccount’s scheduling data. With the correct API key, an integration can check availability, retrieve bookings, create appointments, update bookings, and cancel them.

Calendar Endpoints

Full request and response reference for every calendar endpoint
This API is the agent surface: it covers calendar availability and bookings only. Contacts are not exposed to this API key — they’re managed from the dashboard under an authenticated session.

​
Get an API key

1

Open the calendar API keys page

From the sidebar, open Calendar → API Keys. Only agency owners can create calendar API keys.
2

Create a key

Click Create API Key, give it a name, optionally set an expiry, and select the permissions the integration needs (see the permission model below).
3

Copy the key

Copy the plain-text key immediately — it’s shown only once. The key is scoped to the selected subaccount.
Full product walkthrough: Calendar integration.

​
Base URL

​
Authentication

All endpoints require an API key in the x-calendar-api-key request header.
The plain-text API key is only shown once when you create it. Store it securely because it cannot be retrieved later.

​
Permission Model

Each key is permission-scoped. The key must include the correct permission for the operation being requested. This lets you create narrowly scoped keys for different automation jobs instead of reusing one all-access key everywhere.

​
Rate Limiting

  • Limit: 60 requests per minute per API key
  • Window: Sliding 1-minute window
  • Failure response: 429 Too Many Requests
If you are building an AI workflow, add retry logic with backoff instead of sending burst retries.

​
Endpoint Summary

Continue to Calendar Endpoints for field-level request and response examples.

​
Common Booking Fields

Most booking responses use the same core fields:

​
Error Format

Calendar API errors use a simple JSON body:
The full list of common error codes and messages is documented on Calendar Endpoints.