API reference
All 45 public operations, grouped by product area.
The complete machine-readable schema of every operation is openapi.json.
Appointments engine
Read an appointments business's services, staff and appointments, and book, move or cancel appointments, with an API key. A key from a table-reservations organization gets 403 wrong_vertical.
| Method | Operation |
|---|---|
GET | List appointments |
POST | Book an appointment |
GET | List services |
GET | List staff |
PATCH | Change an appointment |
POST | Cancel an appointment |
Hospitality engine
Read a venue's tables, service periods and reservations, and book, change or cancel reservations, with an API key. A key from an appointments organization gets 403 wrong_vertical.
Shared
Read the organization, its clients and its free times with an API key. The same for both engines.
| Method | Operation |
|---|---|
POST | Subscribe a webhook |
DELETE | Unsubscribe a webhook |
GET | Fetch a webhook event |
GET | List clients |
GET | Read the organization |
GET | Find free times |
Public booking (appointments)
No authentication. Find free appointment times at a business and book one, the same calls its booking page at /book/{slug} makes.
| Method | Operation |
|---|---|
POST | Take yourself off the waitlist |
GET | List bookable appointment slots |
POST | Join the waitlist for a full day (public, appointments) |
POST | Book an appointment |
POST | Preview a promo code |
Public booking (hospitality)
No authentication. Find free table times and book in two steps: hold a table, then confirm it with the guest's details. An appointments business answers 404.
Guest self-service
The token in a guest's booking link is the whole credential: move or cancel the booking, answer the intake form, or message the venue. One set of endpoints serves both engines, because a link points at a booking, not at a product.
| Method | Operation |
|---|---|
GET | Place in the walk-in line |
DELETE | Leave the walk-in line |
POST | Message the venue |
PATCH | Change a booking, or its dietary preferences and occasion |
DELETE | Cancel a booking |
PUT | Answer the venue's intake form |
Agent (MCP)
One JSON-RPC endpoint (Model Context Protocol) an AI assistant uses to find free times at any Gaplessly business on a guest's behalf. No authentication. See the MCP connector page.
| Method | Operation |
|---|---|
POST | MCP endpoint |