Skip to main content
GET
Get a list of bookings

Autorisierungen

Authorization
string
header
erforderlich

The access token received from the authorization server in the OAuth 2.0 flow.

Header

Authorization
string
erforderlich

Bearer Token

Abfrageparameter

include
string

Comma-separated list of related resources to sideload.

Supported paths include: resource, resource.parent, order, order.customer, order.utm_tracker, customer, service, booking_series, sub_bookings, sub_bookings.resource, sub_bookings.service, booking_add_ons, booking_add_ons.add_on, booking_participants.

page[number]
integer
Standard:1

Page index (1-based)

page[size]
integer
Standard:15

Items per page

filter[start_date_range]
string

Filter by start_date. Accepts a dynamic keyword (today, yesterday, tomorrow, this_week, last_week, next_week, this_month, last_month, next_month, this_year, last_year, past, future) or a static range as YYYY-MM-DD:YYYY-MM-DD.

filter[end_date_range]
string

Filter by end_date. Same keyword/static-range syntax as filter[start_date_range].

filter[period_range]
string

Filter by the booking's active period (overlap between start_date and end_date). Same keyword/static-range syntax as filter[start_date_range].

filter[resources]
string[]

One or more resource IDs. Use repeated-bracket form (filter[resources][]=155930) or a comma-separated list.

filter[resource_groups]
string[]

One or more resource group IDs.

filter[services]
string[]

One or more service IDs.

filter[status]
enum<string>[]

One or more booking statuses.

Verfügbare Optionen:
requested,
accepted,
declined,
canceled,
expired,
completed
filter[communities]
string[]

Filter by community IDs (customers that belong to at least one of these communities).

filter[add_ons]
string[]

Only return bookings that have at least one of the given add-on IDs.

filter[tests]
string[]

Only return bookings that have at least one test result for one of the given test IDs.

filter[test_results]
string[]

Filter by test result values.

filter[email]
string

Filter by customer email (exact match).

Full-text search across booking number, description, customer name and email.

filter[hide_blocker]
boolean

Exclude blocker bookings from the result set.

filter[upcoming_only]
boolean

Only return bookings whose end_date is in the future.

filter[past_only]
boolean

Only return bookings whose end_date is in the past.

filter[tested_only]
boolean

Only return bookings that have at least one associated test result.

filter[exclude_sub_bookings]
boolean

Exclude sub-bookings (bookings that belong to a parent booking) from the result set.

filter[exclude_series_master]
boolean

Exclude the series master bookings of recurring series; individual occurrences are still returned.

sort
string

Sort field. Prefix with - for descending. Common values: period, -period, start_date, -start_date, created_at, -created_at, status.

fields[bookings]
string

Comma-separated list of booking attributes to return.

fields[resources]
string

Comma-separated list of resource attributes to return for included resources.

fields[orders]
string

Comma-separated list of order attributes to return for included orders.

fields[customers]
string

Comma-separated list of customer attributes to return for included customers.

fields[services]
string

Comma-separated list of service attributes to return for included services.

exclude_meta[test_results]
boolean

When 1, omit the test-result meta block from the response to reduce payload size.

o
string

Organization ID

Antwort

OK

data
Booking · object

A booking blocks the related resource from start_date until its end_date while its status is reserved, requested or accepted.

Status values:

  • reserved — booking is reserved until order expiration
  • requested — needs manual acceptance by admin
  • accepted — accepted (automatically or manually)
  • rejected — rejected by admin before fulfillment; always yields a 100% refund when payment exists
  • canceled — canceled by customer or admin; refund follows the configured cancellation policy conditions
  • expired — booking expired because the check-in time passed without check-in