Skip to main content

My Playrooms Public API

The public API lets applications search playrooms, inspect booking options, create bookings, and obtain a payment session. All public endpoints use the versioned /v1 base path.

Authentication​

Public API requests use an API key in the X-API-Key header. See authentication.

Endpoints​

  • GET /v1/playrooms - browse the playroom catalog
  • GET /v1/playrooms/{urlPath} - read playroom details
  • GET /v1/playrooms/{urlPath}/booking-options - read available times and prices
  • POST /v1/orders - create a booking with an API key
  • GET /v1/orders/{orderId} - read a booking created by your API key
  • POST /v1/orders/{orderId}/payment - create a payment session
  • GET /v1/openapi.json - machine-readable OpenAPI description

Searching and reading playrooms do not require an API key. Creating bookings and reading or paying for an order requires the API key that owns the order.

Code examples​

See the code examples.