API reference

The complete machine-readable schema of every operation is openapi.json.

Appointments engine

Services, staff and appointments. Session-authenticated, engine-guarded: a hospitality org gets 403.

Method	Operation
POST	Create a service
PATCH	Reorder and/or regroup services
PATCH	Update a service
DELETE	Delete a service (admin, or manage_services)
POST	Upload a service image
DELETE	Remove a service image
POST	Create a service group
PATCH	Reorder service groups
PATCH	Update a service group
DELETE	Delete a service group (admin, or manage_services)
POST	Create a staff member
PATCH	Update a staff member
DELETE	Delete a staff member (admin, or manage_staff)
POST	Archive a staff member (admin, or manage_staff)
POST	Reactivate an archived staff member (admin, or manage_staff)
POST	Upload a staff photo
DELETE	Remove a staff photo
POST	Request a date-specific schedule override
POST	Mark a staff member away (admin, or manage_staff)
DELETE	Remove a time-away entry (admin, or manage_staff)
GET	List availability-override requests
PATCH	Cancel or reject an availability-override request
POST	Approve a pending availability-override request
POST	Create an appointment, or a repeat series (staff side)
GET	Whether this booking is part of a repeat series
GET	Read one repeat series and its visits
PATCH	End a series early
GET	Read one booking
PATCH	Update an appointment
GET	List appointments (API key)
GET	List services (API key)
GET	List staff (API key)
POST	Create a product
PATCH	Update a product, or archive/restore it
POST	Upload a product image
DELETE	Remove a product image
GET	A product's recent stock movements
POST	Adjust a product's stock
GET	A variant's recent stock movements
POST	Adjust a variant's stock
POST	Create a product category
DELETE	Delete a product category
POST	Create a package
PATCH	Update a package, or activate/deactivate it
POST	Sell a package to a customer
POST	Apply, or manually correct, a customer package's sessions
GET	Read the venue opening hours (admin, or manage_org_settings)
PUT	Replace the venue opening hours (admin, or manage_org_settings)
PATCH	Save a page's draft content (admin, or manage_org_settings)
POST	Publish a page's draft content live (admin)
GET	Read this company's connected custom domain
POST	Connect a custom domain (admin)
PATCH	Re-check this company's connected domain against Vercel (admin)
DELETE	Disconnect the connected custom domain (admin)
GET	This website's traffic (self-hosted, cookieless)
POST	Take the public site offline, or bring it back (admin)

Hospitality engine

Tables, service periods and reservations. Session-authenticated, engine-guarded: an appointments org gets 403.

Method	Operation
GET	List reservations (API key)
GET	List tables (API key)
GET	List service periods (API key)
POST	Create a table
POST	Create a range of tables in one request
POST	Place a furniture-set piece (a bar, a multi-tabletop banquette)
GET	List a furniture-set piece's configured combos
POST	Configure a combo for a furniture-set piece
DELETE	Remove a furniture-set combo
PATCH	Save one floor's decor elements
POST	Upload the backdrop image for one floor
DELETE	Remove a floor's backdrop image
PATCH	Save floor-plan geometry for a batch of tables and rooms
PATCH	Update a table
DELETE	Delete a table (admin)
POST	Create a level (floor)
PATCH	Reorder levels (floors)
PATCH	Update a level
DELETE	Delete a level (admin)
POST	Upload a level photo
DELETE	Remove a level photo
GET	List guests waiting for a table
POST	Add a party waiting now at the door
POST	Offer a waitlisted guest a table
POST	Text a "waiting now" guest that their table is ready
PATCH	Close out a waitlist entry
POST	Pencil in or book a big-group enquiry
DELETE	Release a pencilled-in hold
POST	Confirm a pencilled-in big-group booking
PATCH	Move a big-group enquiry along
POST	Create a link group
PATCH	Rename a link group
DELETE	Delete a link group (admin)
GET	List a combine group's staff-drawn adjacency edges
POST	Draw an adjacency edge between two tables
DELETE	Remove an adjacency edge
GET	Area locks touching a date
POST	Lock a floor, room or table
DELETE	Remove an area lock (admin)
GET	Read the floor's shared note for a date
PUT	Save the floor's shared note for a date
POST	Create an area (room)
PATCH	Reorder areas (rooms)
PATCH	Update an area
DELETE	Delete an area (admin)
POST	Upload an area (room) photo
DELETE	Remove an area photo
PUT	Replace a named service period (admin, or manage_services)
POST	Create a reservation (staff side)
POST	Add a floor server
PATCH	Rename a floor server
DELETE	Remove a floor server
PUT	Assign a table to a server for a date
PATCH	Update a reservation
POST	Create an experience
PATCH	Update an experience, or archive/restore it
POST	Upload an experience image
DELETE	Remove an experience image
GET	The door-staff guestlist for one experience
POST	Scan or manually check in a ticket
GET	Hospitality's "Your booking funnel" (self-hosted, cookieless)

Public booking (appointments)

Unauthenticated. The widget a customer uses at /book/{slug} (or /{slug}/book: both are real, permanently-live addresses for the same page). Not engine-guarded: see the 403 note above.

Method	Operation
GET	List bookable appointment slots
POST	Book an appointment (guest checkout)
POST	Preview a promo code before checkout (public, unauthenticated)

Public booking (hospitality)

Unauthenticated, two-step (hold, then confirm). Refuses an appointments org with 404.

Method	Operation
POST	Send a big-group enquiry (public)
POST	Join the waitlist (public)
GET	List bookable table slots
GET	List which tables are free for one exact slot
POST	Hold a table (guest checkout, step 1)
PATCH	Confirm a held table (guest checkout, step 2)
DELETE	Release a held table

Guest self-service

Unauthenticated except for the booking's manage token, which is the whole credential. One endpoint serves both engines because a manage link points at a booking, not at a product.

Method	Operation
POST	Message the venue about a booking
PATCH	Move a booking to another time
DELETE	Cancel a booking
PUT	Answer the venue's intake form
POST	Submit the private half of a booking's post-visit feedback
POST	Set or clear a customer's marketing consent from the link in a marketing email
GET	Log a guest's thumb-up tap and redirect to the org's Google review link
GET	Retired email logo: redirects to the G7 mark

Agent (MCP)

One unauthenticated JSON-RPC endpoint (Model Context Protocol) that lets an AI assistant read the public booking surface on a guest's behalf. Not REST, and deliberately documented here anyway: it is a public endpoint on this domain, and an agent that reads this document is exactly the reader it is for. Distinct from the PRIVATE per-tenant MCP server, which is not built, is gated behind an sk_live_ key, and never takes a venue as an argument.

Method	Operation
POST	Public booking MCP endpoint (JSON-RPC)

Shared

Clients, teammates, messages, notes, templates, branding, profile, account, organization settings. Deliberately NOT engine-guarded: a client record and a teammate mean the same thing to both products, and guarding these would lock half the product out of its own settings.

Method	Operation
GET	List clients (API key)
GET	Read the organization (API key)
POST	Send product feedback (bug report, idea, or general) to Solvintia
POST	Attach a screenshot to a feedback submission you just sent
POST	Create a client
PATCH	Update a client
POST	Erase a client's personal data on request (admin)
POST	Add a form to the catalog (admin)
PATCH	Edit a catalog form, or toggle active (admin)
POST	Send a catalog form to a customer
PUT	A customer answers a sent form (public, unauthenticated)
POST	Record a sale
POST	Void a sale
GET	Live client search for CustomerPicker
GET	Global search, backs the dashboard's Cmd/Ctrl+K palette
POST	Send a message to the native AI assistant (v1, read-only)
POST	Attach a CSV/TSV/XLSX file to an AI assistant conversation
GET	Get a short-lived download link for an attached file
POST	Draft an inbox reply or a private note with the AI assistant (single-shot, read-only)
GET	Read how much of this period's AI assistant allowance is left (any role)
POST	Invite a teammate (admin)
PATCH	Set the caller's own staff-alert preferences
PATCH	Toggle a Recipe on/off, or edit its message (admin)
PATCH	Set a teammate's granular permissions (admin)
DELETE	Remove a teammate (admin)
POST	Resend a pending invite (admin)
POST	Cancel a pending invite (admin)
POST	Accept an invite
POST	Request a new invite link (public)
POST	Request a new invite link for the signed-in account (session-gated)
POST	Create an invited account (public)
POST	Request beta access (public)
POST	Sign up for Gaplessly product updates (public)
POST	Confirm a newsletter sign-up (public)
PATCH	Update organization settings (admin, or manage_org_settings, or deposit_staff_editable)
GET	One thread's messages
POST	Reply to a guest
PATCH	Mark a thread read
GET	Timestamp of the newest visible message
GET	What the notification bell shows
PATCH	Mark the notification bell seen
PATCH	Write the private staff note on a booking or enquiry
PUT	Create or replace an intake form (admin)
PATCH	Set the guest self-service policy (admin, or manage_org_settings)
PATCH	Attest or withdraw the pre-existing-list marketing declaration (admin, or manage_org_settings)
POST	Accept the current Terms of Service for this business (admin)
POST	Turn review routing on or off for this business (admin)
GET	Read notification templates
DELETE	Revert one template slot to the default (admin)
PUT	Customise one template slot (admin, paid)
POST	Upload the organization logo (admin, or manage_org_settings)
DELETE	Remove the organization logo (admin, or manage_org_settings)
GET	List this organization's campaigns
POST	Start a new campaign draft (admin, or manage_org_settings)
PATCH	Autosave a campaign draft (admin, or manage_org_settings)
DELETE	Delete a campaign draft (admin, or manage_org_settings)
POST	Upload a campaign photo (admin, or manage_org_settings)
DELETE	Remove a campaign photo (admin, or manage_org_settings)
GET	Live "will reach N" count for a segment or tag
POST	Render a live email preview of a draft campaign
POST	Send a campaign for real (admin, or manage_org_settings)
POST	Send a test of a campaign to yourself (admin, or manage_org_settings)
POST	Issue a gift card (admin, or manage_org_settings)
POST	Record a gift card redemption
GET	Resolve a gift card code to its id and balance
POST	Create a promotion: an automatic sale or a promo code (admin, or manage_org_settings)
PATCH	Enable or disable a promotion (admin, or manage_org_settings)
PATCH	Save the Booking Page settings draft (admin, or manage_org_settings)
POST	Publish the Booking Page settings draft live (admin)
GET	Dates that do not follow the recurring week
POST	Set what happens on one date (admin, or manage_org_settings)
DELETE	Return a date to the recurring week (admin, or manage_org_settings)
GET	List this company's tiered no-show fees
POST	Add a tier (admin, or deposit_staff_editable)
PATCH	Edit a tier (admin, or deposit_staff_editable)
DELETE	Remove a tier (admin, or deposit_staff_editable)
GET	Public holidays for this business's country and state
POST	Switch between the subdomain and the classic /{slug} link as the asserted address (admin)
GET	Every business this account can act in
POST	Point this account at another business it belongs to
GET	Read the paid add-on catalogue and what this org has (admin)
POST	Start add-on checkout, open the billing portal, or cancel an add-on (admin)
GET	Read this business's tier and any self-serve upgrades (admin)
POST	Start tier checkout, or change a paid plan in place (admin)
GET	Read Gaplessly's own billing details for this org (admin)
PATCH	Save Gaplessly's own billing details for this org (admin)
GET	Read Gaplessly's own invoices to this org, newest first (admin)
GET	Read this business's metered usage for the current billing period (admin)
GET	Read this org's Stripe Connect status (admin)
POST	Start or resume Stripe Connect onboarding (admin)
GET	Re-sync billing from Stripe, then redirect to Organization settings
POST	Refund a guest deposit or a card-on-file no-show fee, in full or in part (admin)
GET	The Takings report: gross, refunded and net Stripe-collected money over a date range
GET	Preview the suggested tier amount for a booking (admin)
POST	Charge a card-on-file no-show fee (admin)
POST	Resend a receipt or tax invoice (admin)
POST	Begin transferring ownership of the organization
POST	Confirm a pending ownership transfer (owner, via emailed link)
POST	Cancel a transfer in progress (owner only)
POST	Create a business: a new organization, or another one in the caller's own (onboarding)
POST	Live booking-URL availability while typing, during onboarding
POST	Look up a Google Business Profile for onboarding prefill
GET	Start the Google Business Profile OAuth flow (admin, redirect-only)
GET	Google OAuth callback: exchange the code, resolve the location, store the connection
POST	Disconnect this company's Google Business Profile
POST	Reply to a Google review from this app's own dashboard
POST	Upload the booking-page background (admin, or manage_org_settings)
DELETE	Remove the booking-page background (admin, or manage_org_settings)
POST	Upload the About section photo (admin, or manage_org_settings)
DELETE	Remove the About section photo (admin, or manage_org_settings)
POST	Upload the website's own hero photo (admin, or manage_org_settings)
DELETE	Remove the website's own hero photo (admin, or manage_org_settings)
POST	Upload your own profile photo
DELETE	Remove your own profile photo
DELETE	Delete your own account
GET	List this org's recent imports and exports (admin)
POST	Start an export (admin, active subscription only)
POST	Dry-run an import file (admin)
POST	Commit an import (admin)
POST	Ask for free migration help (admin)
PATCH	Manually adjust a loyalty member's points balance (admin)

API keys

Issue and revoke the credentials programmatic callers use. Session-authenticated and admin-only, and deliberately unreachable with an API key: there is no scope for key management, so a leaked key cannot mint another.

Method	Operation
POST	Issue an API key (admin)
DELETE	Revoke an API key (admin)