Scheduler Reference
Scheduler domain API for managing event types, availability, bookings, and calendar connections
Define and manage booking page types (1-on-1, group, etc.).
- GET
/api/v1/scheduler/event-types— List event types - POST
/api/v1/scheduler/event-types— Create an event type - GET
/api/v1/scheduler/event-types/{id}— Get an event type - PATCH
/api/v1/scheduler/event-types/{id}— Update an event type - DELETE
/api/v1/scheduler/event-types/{id}— Delete an event type - POST
/api/v1/scheduler/event-types/{id}/members— Set event type members
Define and manage available time slots for bookings.
- GET
/api/v1/scheduler/availability— List availability schedules - POST
/api/v1/scheduler/availability— Create an availability schedule - GET
/api/v1/scheduler/availability/{id}— Get an availability schedule - PATCH
/api/v1/scheduler/availability/{id}— Update an availability schedule
List, view, cancel, and reschedule bookings.
- GET
/api/v1/scheduler/bookings— List bookings - GET
/api/v1/scheduler/bookings/{id}— Get a booking - POST
/api/v1/scheduler/bookings/{id}/cancel— Cancel a booking - POST
/api/v1/scheduler/bookings/{id}/reschedule— Reschedule a booking
Public booking page without authentication. External users can view available slots and book.
- GET
/api/v1/scheduler/p/{orgSlug}/{eventTypeSlug}— Get public event type info - GET
/api/v1/scheduler/p/{orgSlug}/{eventTypeSlug}/slots— Get available slots - POST
/api/v1/scheduler/p/{orgSlug}/{eventTypeSlug}/book— Book a slot
Token-based guest booking view and cancellation. Accessed via booking confirmation email links.
- GET
/api/v1/scheduler/b/{token}— Get guest booking info - POST
/api/v1/scheduler/b/{token}/cancel— Cancel guest booking
Manage scheduling proposals where multiple candidate times are offered for selection.
- GET
/api/v1/scheduler/proposals— List proposals - POST
/api/v1/scheduler/proposals— Create a proposal - GET
/api/v1/scheduler/proposals/{id}— Get a proposal
Token-based guest proposal viewing and acceptance. Accessed via proposal email links.
- GET
/api/v1/scheduler/pr/{token}— Get guest proposal info - POST
/api/v1/scheduler/pr/{token}/accept— Accept guest proposal
Manage connections and sync with external calendars such as Google Calendar.
- POST
/api/v1/scheduler/calendars/connect/google— Connect Google Calendar - GET
/api/v1/scheduler/calendars/callback/google— Google OAuth callback - GET
/api/v1/scheduler/calendars/connections— List calendar connections - POST
/api/v1/scheduler/calendars/connections/{id}/sync— Sync calendar - POST
/api/v1/scheduler/calendars/connections/{id}/disconnect— Disconnect calendar
Scheduler dashboard, settings, and calendar event retrieval.
- GET
/api/v1/scheduler/dashboard— Get dashboard - GET
/api/v1/scheduler/settings— Get settings - PATCH
/api/v1/scheduler/settings— Update settings - GET
/api/v1/scheduler/calendar-events— List calendar events
View change history of scheduler data.
- GET
/api/v1/scheduler/audit-logs— List audit logs