Skip to main content
The channel integration uses the same API key mechanism as the rest of the Platform API — no separate enablement step is needed.

Create an API key

API keys are created in the admin dashboard under Settings - APIs and MCP. See Creating an API token for the full flow.
API access is a paid feature. Organizations on the free plan or in trial can’t create API keys, and existing keys stop working if an organization downgrades (requests return 403 with code: "PLAN_FEATURE_LOCKED").
Grant only the scopes the integration needs:
  • areas:read - list areas and read their availability
  • bookings:read - read a booking
  • bookings:write - create and cancel bookings
bookings:write is required to create or cancel bookings. A read-only key cannot write bookings, and the legacy broad read grant does not satisfy write scopes.
Pass the key as a Bearer token on every request:
The key is tied to one organization, so all areas and bookings are scoped to that organization automatically.

Rate limits and errors

The channel endpoints share the Platform API’s limits and error model:
  • 100 requests per minute per organization. A 429 response includes a Retry-After header.
  • Errors return a JSON body of the shape { "error": "...", "message": "...", "code": "..." }.
See Rate limiting and Errors for the full reference.