API reference
Calendars API
Calendar connections and bookings: connect a provider, read availability, create and cancel bookings, and list what is coming up.
Endpoints
8 operations, each with its parameters, schemas and an example request on its own page.
- get/api/calendarsList calendars
- get/api/calendars/bookings/upcomingList upcoming
- post/api/calendars/bookings/{booking_id}/cancelCancel booking
- get/api/calendars/connect/{provider}Connect a calendar — Starts a connect flow. Returns the URL for the browser to visit.
- patch/api/calendars/{connection_id}Update connection
- delete/api/calendars/{connection_id}Disconnect a calendar — Removes the connection. Bookings already made survive it.
- get/api/calendars/{connection_id}/availabilityGet availability
- post/api/calendars/{connection_id}/bookCreate booking
Authentication
Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.
Objects returned
The models these endpoints send back, with every field. Open one to read it.
Message2 fields
messagestringrequiredokbooleanDefault: true
ConnectResponse2 fields
authorization_urlstringrequiredproviderstringrequired
Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.