Skip to main content
GET
List bookings

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Query Parameters

from
string

Inclusive lower bound on booking start time, as an ISO date-time or YYYY-MM-DD. Defaults to to - 7d, or now.

to
string

Exclusive upper bound on booking start time, as an ISO date-time or YYYY-MM-DD. Defaults to from + 7d.

clubId
integer

Only bookings at this club

areaId
integer

Only bookings on this area

classId
integer

Only the attendees of this class occurrence. Equivalent to GET /v1/platform/classes/{id}/bookings, which additionally resolves each attendee's name and check-in.

eventId
integer

Only bookings for this event

instructorId
integer

Only bookings led by this instructor

contactId
integer

Only bookings for this contact

status
string

Only bookings with this status (e.g. confirmed, pending, cancelled)

include
string

Comma-separated expansions to embed on each booking, loaded once for the whole page. customer is the booking's customer, identical to what GET /v1/platform/contacts/{id} returns, and needs contacts:read. money is what the booking billed, what was paid and what is still outstanding, with the charges, cancellation credits, payments and refunds behind those figures, and needs transactions:read. cancellation is the cancellation terms stamped on the booking when it was accepted (with the deadlines they give, and until when it cancels for free) and, once cancelled, who cancelled it, when, why, with how much notice and at what refund. An expansion whose scope the key lacks is refused with 403 rather than left out.

Pattern: ^(customer|money|cancellation)(,(customer|money|cancellation))*$
Example:

"customer,money,cancellation"

limit
integer
default:50

Maximum number of bookings to return

Required range: 1 <= x <= 100
offset
integer
default:0

Number of bookings to skip

Required range: x >= 0

Response

Page of bookings

data
object[]
total
integer

Total bookings matching the filters, ignoring pagination

limit
integer
offset
integer