Sign in
Booking Endpoints

Search bookings

Search bookings by customer name, email, mobile, band name, or booking code. Supports status filtering.

get/bookings/search

Query parameters

qstring

Search query

status_filter'active' | 'cancelled' | 'cancelled_and_active'

Filter by booking status

pageinteger
per_pageinteger

Headers

Authorizationstring required

Response

Search results

codestring

The code of the booking - seen by customers on the booking page

idstring

Same as code

recordingboolean

Whether the room has been marked as a recording

regularboolean

Whether the booking is part of a regular booking

online_bookingboolean

Whether the booking was made online by the customer

created_atinteger

Unix timestamp from epoch

updated_atinteger

Unix timestamp from epoch

approved_atinteger

Unix timestamp from epoch - when the booking was approved (if approved)

rejected_atinteger

Unix timestamp from epoch - when the booking was rejected (if rejected)

priceinteger

The price of the booking time only in cents/pence/units

price_currencystring

The currency of the price

titlestring

The title of the booking - this is generated from the customer and group names

start_atinteger

Unix timestamp from epoch

end_atinteger

Unix timestamp from epoch

durationinteger

The duration of the booking in seconds

duration_hoursnumber

The duration of the booking in hours, e.g. 1pm-2.30pm = 2.5 hours

duration_full_hoursinteger

The duration of the booking in hours, rounded up to each full hour, e.g. 1pm-2.30pm = 3 hours

activity_namestring

The name of the activity the booking is part of - e.g. 'Rehearsal'

datesstring[]

The dates that the booking is part of in local time - given as strings YYYYMMDD format

timezonestring

The timezone of the booking

has_amount_dueboolean

Whether the booking still has an amount due

remaining_amountinteger

The remaining amount due for the booking

cancelledboolean

Whether the booking has been cancelled

taken_bystring

The name of the staff member who took the booking - if null, the booking was made by the customer themselves

Changes

Changed in 4 of the 32 revisions of this API.15

  • v23535cc88f4072See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • v240748de0c2992See the full diff
    • ○

      api tag Booking Endpoints added

      api-tag-added

    • ○

      api tag Booking Management Endpoints removed

      api-tag-removed

  • v271bc3de607c71See the full diff
    • ○

      endpoint added

      endpoint-added

  • v295c52cb13f9a1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog