API Documentation

Build on EscapeBoost

Connect your POS system, build custom integrations, let AI agents book on behalf of your customers, or sync calendars with third-party tools — all through our RESTful API.

API access is available on the Enterprise plan. Contact us to get set up.

What you can build

Full access to your bookings, rooms, schedules, and customer data.

RESTful API

Standard HTTP methods (GET, POST, PUT, DELETE). JSON request and response bodies. Predictable resource-oriented URLs.

Secure authentication

API keys for server-to-server communication, scoped to your organization. We provision and rotate keys for you.

Real-time updates

Changes to bookings, schedules, and rooms sync instantly. No polling required. Webhooks notify your system when events happen.

Webhook support

Get notified when bookings are created, updated, or canceled. Build automated workflows without constant API calls.

Example Request

curl https://app.escapeboost.com/api/v1/public/me \
  -H "Authorization: Bearer $ESCAPEBOOST_KEY"

Contact us for API access (Enterprise). Full reference at /backend/docs/api.md.

Key API Endpoints

Full CRUD operations on all core resources.

Bookings

GET
/v1/bookings

List all bookings with filters (date, room, status)

GET
/v1/bookings/:id

Get a single booking by ID

POST
/v1/bookings

Create a new booking

PUT
/v1/bookings/:id

Update a booking (reschedule, modify guests)

DELETE
/v1/bookings/:id

Cancel a booking and process refund

Rooms

GET
/v1/rooms

List all rooms/experiences

GET
/v1/rooms/:id

Get room details, pricing, and availability

POST
/v1/rooms

Create a new room or experience

PUT
/v1/rooms/:id

Update room details or pricing

Schedules

GET
/v1/schedules

Get availability for a date range

POST
/v1/schedules/block

Block out dates for maintenance or events

Customers

GET
/v1/customers

List all customers

GET
/v1/customers/:id

Get customer profile and booking history

Authentication

All API requests require authentication via API keys. Contact us to get API access (Enterprise plan).

Include your API key in the header

Authorization: Bearer YOUR_API_KEY
  • API keys are scoped to your organization. They cannot access other customers' data.
  • We can issue keys scoped to the access your integration needs.
  • Contact us to rotate or revoke a key.

Webhooks

Get real-time notifications when events happen in your account. No polling required.

booking.created

Fired when a customer completes a new booking.

booking.updated

Fired when a booking is rescheduled or modified.

booking.canceled

Fired when a booking is canceled and refunded.

payment.succeeded

Fired when payment is successfully processed via Stripe.

Webhooks deliver a JSON payload to your endpoint via HTTP POST. We retry failed deliveries with exponential backoff.

API Documentation

Full REST reference and quickstart snippets live in the backend docs.

Contact us to get an API key, then point your integration or AI agent at /api/v1/public.

Contact us for API access