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.
- Load page
- Find times
- Hold slot
- Save details
- 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.
Step 2: Save customer details
attempts/:attempt_id/details saves details and form answers.
Step 3: Start checkout
attempts/:attempt_id/checkout starts checkout. Then read the attempt status.
Routes
These paths include the /public/booking prefix.
| Method | Path | Purpose |
|---|---|---|
| GET | /public/booking/pages/:type/:slug | Load a booking page. |
| POST | /public/booking/selection/context | Resolve Service, Team, or Member choices. |
| POST | /public/booking/availability/query | Find available times. |
| POST | /public/booking/holds | Temporarily reserve a slot. |
| POST | /public/booking/attempts/:attempt_id/details | Save customer details and form answers. |
| POST | /public/booking/attempts/:attempt_id/checkout | Start checkout. |
| POST | /public/booking/resume | Resume with a token. |
| GET | /public/booking/attempts/:attempt_id/status | Read current progress. |
| POST | /public/booking/attempts/:attempt_id/resume/check | Check whether an attempt can resume. |
| GET | /public/booking/appointments/:appointment_id/summary | Read a private appointment summary. |
| POST | /public/booking/appointments/:appointment_id/reschedule | Change the appointment time. |
| POST | /public/booking/appointments/:appointment_id/cancel | Cancel the appointment. |
| GET | /public/booking/join | Read a video meeting join summary. |
| POST | /public/booking/join | Get the meeting address to join. |
| POST | /public/booking/join/request-link | Ask for a personal join link by email. |
Errors to handle
| Error or state | Client action |
|---|---|
| Invalid or expired hold | Return to time selection. |
| Slot unavailable | Refresh availability and choose a different time. |
| Invalid attempt state | Read the current status before the next step. |
| Missing Member or Team choice | Ask for an assigned selection. |
| Invalid, expired, or claimed resume token | Obtain the latest private link. |
| Closed edit window or final appointment | Stop the action and direct the customer to the business. |
| 401 or 403 | Check the session, Organization, token, or permission as appropriate. |
| 429 | Wait before retrying; do not loop rapidly. |
Use outgoing webhooks for subscribed event notifications.