Skip to content
Docs home

DEVELOPER · UPDATED AUGUST 2026

API Surface

The verified public API surface: embed script, booking token endpoints, health, metrics, cron, SCIM — with conventions for requests, responses, and errors.

Surface map

QUE does not expose an open key-based REST API. Its public surface is composed of deliberate, narrowly-scoped endpoints, each documented below with its real behavior.

EndpointMethodAuthPurpose
/api/public/embed/:slug.jsGETNone (slug validated against published tenant)Embeddable booking widget loader
/u/:slug/* booking endpointsGET/POSTBooking tokenAvailability, create, cancel, reschedule, booking by token
/api/public/healthzGETNonePlatform health: status, db, db_ms, uptime_ms, ts
/api/public/metricsGETBearer METRICS_TOKENPrometheus-format metrics scrape
/api/public/cron/*POSTBearer cron secretScheduled dispatch: reminders, workflows, webhooks, domain verification
/api/public/webhook/stripePOSTstripe-signature headerInbound Stripe payment events
/api/public/webhook/alertmanagerPOSTX-Alertmanager-Secret headerInbound alert sink (fail-closed)
/api/public/scim/v2/*GET/POST/PATCH/DELETESCIM bearer tokenUser provisioning (list, create, activate, deactivate, delete)
/api/public/marketing.leadPOSTNone (rate-limited)Public lead capture
/api/public/newsletter.subscribePOSTNoneNewsletter subscription

Booking token endpoints

The public booking surface exposes a small set of token-gated endpoints. They are consumed by the public booking UI and by the management links customers receive; they are the right integration point for custom booking surfaces built on QUE.

textBooking endpoint behaviors
GET  getBookingConfig      → service/tenant config for the booking surface
GET  getAvailableSlots   → computed slots (service, staff, resource, overrides)
POST createPublicBooking → create booking; returns confirmation + management link
POST cancelPublicBooking → operator-side cancellation
GET  getBookingByToken   → booking detail via token
POST cancelByToken       → customer-side cancellation via token
POST rescheduleByToken   → customer-side reschedule via token

Conventions

Responses follow a consistent contract: typed errors instead of generic 500s, tenant scope on every response, and status fields that name the actual state (ok/degraded, pending/confirmed, sent/failed). Paginated list endpoints use page and per-page parameters. Cron endpoints accept POST with a bearer secret and return JSON outcomes with per-item status so scheduled consumers can detect partial failures.

There is no SDK

QUE does not publish a client SDK. Integrate through the endpoints above and the embed script. If you build a wrapper for your own stack, treat these behaviors — not an imagined convenience layer — as the contract.

STILL READING

Something here still feels worth checking together.

This documentation describes the product exactly as it is implemented. If a behavior you expected is not here — or is here and does not match your deployment — tell the team. Implementation questions start on the contact page.