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.
| Endpoint | Method | Auth | Purpose |
|---|---|---|---|
| /api/public/embed/:slug.js | GET | None (slug validated against published tenant) | Embeddable booking widget loader |
| /u/:slug/* booking endpoints | GET/POST | Booking token | Availability, create, cancel, reschedule, booking by token |
| /api/public/healthz | GET | None | Platform health: status, db, db_ms, uptime_ms, ts |
| /api/public/metrics | GET | Bearer METRICS_TOKEN | Prometheus-format metrics scrape |
| /api/public/cron/* | POST | Bearer cron secret | Scheduled dispatch: reminders, workflows, webhooks, domain verification |
| /api/public/webhook/stripe | POST | stripe-signature header | Inbound Stripe payment events |
| /api/public/webhook/alertmanager | POST | X-Alertmanager-Secret header | Inbound alert sink (fail-closed) |
| /api/public/scim/v2/* | GET/POST/PATCH/DELETE | SCIM bearer token | User provisioning (list, create, activate, deactivate, delete) |
| /api/public/marketing.lead | POST | None (rate-limited) | Public lead capture |
| /api/public/newsletter.subscribe | POST | None | Newsletter 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.
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 tokenConventions
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.