Take the booking
Create, modify and cancel reservations, with an idempotency key so a retry after a timeout resolves to the booking you already made.
API & Webhooks
Book, hold and read your restaurant's reservations from your own systems.
Build on your reservation data
Section titled “Build on your reservation data”The Service API lets you read your restaurant’s reservations and guests programmatically, and lets you book, hold, change and cancel on the restaurant’s behalf. It is a clean, predictable JSON API: stable resource shapes, cursor pagination, ISO-8601 timestamps, and a structured error envelope.
The base URL is https://api.useservice.app.
Your first request
Section titled “Your first request”Create a key in the back office under Settings → Developers, and grant it the scopes your integration needs. Keys are per-restaurant, and the examples here read yours from an environment variable — see Authentication.
curl https://api.useservice.app/v1/reservations \ -H "Authorization: Bearer $SERVICE_API_KEY"Hold the table
Take a slot off sale while a guest pays or decides, then convert the hold into the booking or hand it straight back.
Read reservations & guests
List and retrieve reservations (with table assignments and lifecycle history) and guests (identity, contact, consent, visit stats).
React to changes
Subscribe to signed webhooks for the full reservation lifecycle, holds, and guest and feedback events.
Self-serve
Mint keys and register webhook endpoints from the back office (Settings → Developers), with no
sales call and no support ticket. API access rides on the restaurant’s Premium plan; a key
without it is refused with plan_required.
Predictable & versioned
Date-based versioning pinned per key, so your integration never breaks underneath you.
Start here
Section titled “Start here”IntroductionWhat the API is and the conventions it follows.
AuthenticationUse a restaurant API key as a Bearer token, and pick its scopes.
GlossaryCover, service, shift limits, published booking, sweep — the restaurant words the guides use.
WebhooksRegister endpoints and verify signed events.
API referenceEvery endpoint, generated from the OpenAPI spec.
OpenAPI specDownload the spec for SDK codegen or Postman import.
Use cases
Section titled “Use cases”Seven guides that start from what you are building rather than from an endpoint, and name the constraint that decides whether you can build it.
Build a booking funnelAvailability, seating and the create call — and why a rebuilt funnel needs a server of your own.
Hold a slotTake a table off sale while a payment clears, then convert the hold or hand it back.
Change a held timeThe guest wants a different time from the one you hold: take a new hold, then release the old one.
Book past the rulesWaive a booking rule for a corporate dinner or a party of thirty, and see what can never be waived.
Book a whole roomTake every table in a section for a private event, find the room, and handle a room that is partly taken.
Keep your system in syncWebhooks for the signal, updated_since for the truth, ETags for the cost.
Take a depositBook a slot that asks the guest for a card, and the two refusals that surprise people.