Overview

Bookrail API (2026-09-01)

Booking infrastructure: availability, holds, bookings, their life cycle, and the events they emit.

This document is generated from the Zod schemas of the server and proved by a contract guard that validates every response of the test suite against the schema declared here. In case of a disagreement between this file and any prose documentation, this file is right.

• Every instant is ISO 8601. Any explicit offset is accepted on input; every instant is returned in UTC.
• Identifiers are prefixed (bk_, res_, svc_, …); the prefix says what the object is.
• Lists are cursored: ?limit=&starting_after=, never an offset, and never a total.
• Every POST /v1/... honours Idempotency-Key. The same key within 24 hours replays the same response.

• OpenAPI version: 3.1.0

Authentication

bearerAuth

A secret API key: Authorization: Bearer sk_test_.... Publishable (pk_) keys are refused on every endpoint of this document.

Security scheme type: http

Bearer format: sk_test_... / sk_live_...