Skip to content
Help center
Developers

Understand the booking API flow

Review the current booking routes and their access requirements.

The public booking flow loads a page, finds free times, holds a slot, saves details, and starts checkout.

  1. Load page
  2. Find times
  3. Hold slot
  4. Save details
  5. Checkout

Confirm deployed request schemas and the API base URL with support before you build a client. The route map below does not define a stable public API contract.

What each step looks like

Step 1: Find times and hold a slot

availability/query fills the times. holds reserves the one the customer picks.

Booking page calendar with September 28 and 12:00 selected

Step 2: Save customer details

attempts/:attempt_id/details saves details and form answers.

Your information form with demo name Olivia Park and email olivia@example.test

Step 3: Start checkout

attempts/:attempt_id/checkout starts checkout. Then read the attempt status.

Payment step with Stripe hosted checkout selected and the hold timer

Routes

These paths include the /public/booking prefix.

MethodPathPurpose
GET/public/booking/pages/:type/:slugLoad a booking page.
POST/public/booking/selection/contextResolve Service, Team, or Member choices.
POST/public/booking/availability/queryFind available times.
POST/public/booking/holdsTemporarily reserve a slot.
POST/public/booking/attempts/:attempt_id/detailsSave customer details and form answers.
POST/public/booking/attempts/:attempt_id/checkoutStart checkout.
POST/public/booking/resumeResume with a token.
GET/public/booking/attempts/:attempt_id/statusRead current progress.
POST/public/booking/attempts/:attempt_id/resume/checkCheck whether an attempt can resume.
GET/public/booking/appointments/:appointment_id/summaryRead a private appointment summary.
POST/public/booking/appointments/:appointment_id/rescheduleChange the appointment time.
POST/public/booking/appointments/:appointment_id/cancelCancel the appointment.
GET/public/booking/joinRead a video meeting join summary.
POST/public/booking/joinGet the meeting address to join.
POST/public/booking/join/request-linkAsk for a personal join link by email.

Errors to handle

Error or stateClient action
Invalid or expired holdReturn to time selection.
Slot unavailableRefresh availability and choose a different time.
Invalid attempt stateRead the current status before the next step.
Missing Member or Team choiceAsk for an assigned selection.
Invalid, expired, or claimed resume tokenObtain the latest private link.
Closed edit window or final appointmentStop the action and direct the customer to the business.
401 or 403Check the session, Organization, token, or permission as appropriate.
429Wait before retrying; do not loop rapidly.

Use outgoing webhooks for subscribed event notifications.

More details