API
API overview
A REST API for programmatic access to reservations, guests, vouchers and reports. Available on the Enterprise plan.
Honest scope note
A standalone REST API at
api.onboardos.de with /v1/reservations, /v1/guests and outgoing webhook subscriptions is not yet wired. What does exist today: the CORS-open public widget endpoints (/api/widget/[restaurantId], /api/availability, /api/reservations/public, /api/reservations/manage/[id]) and the MCP gateway at /api/mcp (see MCP overview). There is no "Enterprise plan" gating those endpoints. The page below describes the intended shape of the v1 REST API so you can plan against it.The Onboard REST API gives Enterprise customers programmatic access to the same data and actions available in the dashboard. It is JSON over HTTPS, with predictable resource URLs and standard HTTP verbs.
Base URL and versioning
The API is hosted at https://api.onboardos.de. The current major version is v1; it is included as the first segment of the path on every endpoint. Backwards-incompatible changes ship as a new major version (/v2/) — within a major version, only additive changes are made.
Resource surface
The API exposes five resource families:
- GET/v1/reservations and friends.
- GET/v1/guests and friends.
- POST/v1/vouchers for issuing vouchers programmatically.
- GET/v1/reports/daily for aggregated metrics.
- POST/v1/webhooks to manage webhook subscriptions.
Conventions
- All timestamps are ISO 8601 in UTC.
- All monetary values are in minor units (cents).
- List endpoints support cursor pagination with
?cursor=and?limit=. - Errors return RFC 7807
application/problem+jsonbodies.
Rate limits
The default rate limit is 600 requests per minute per API key. Burst budgets allow short spikes. If you need higher limits, talk to your success manager.