Get a list of bookings
List bookings for the current organization. Supports JSON:API includes, sparse fieldsets, filtering, sorting and pagination.
Date range filters
The filters filter[start_date_range], filter[end_date_range] and filter[period_range] accept either a dynamic keyword or a static range in the format YYYY-MM-DD:YYYY-MM-DD (colon-separated, both ends inclusive).
Supported dynamic keywords:
| Keyword | Meaning |
|---|---|
today | The current day (organization timezone) |
yesterday | The previous day |
tomorrow | The next day |
this_week | Current ISO week (Mon–Sun) |
last_week | Previous ISO week |
next_week | Upcoming ISO week |
this_month | Current calendar month |
last_month | Previous calendar month |
next_month | Upcoming calendar month |
this_year | Current calendar year |
last_year | Previous calendar year |
past | Everything strictly before now |
future | Everything strictly after now |
Examples:
filter[start_date_range]=today
filter[start_date_range]=this_week
filter[start_date_range]=2026-04-01:2026-04-30
Filtering by resources
Use the array syntax to pass one or more resource IDs. The filter accepts either the repeated-bracket form (filter[resources][]=155930) or a comma-separated list (filter[resources]=155930,155931):
filter[resources][]=155930&filter[resources][]=155931
The same syntax applies to filter[resource_groups], filter[services], filter[status], filter[communities], filter[add_ons], filter[tests] and filter[test_results].
Autorisierungen
The access token received from the authorization server in the OAuth 2.0 flow.
Header
Bearer Token
Abfrageparameter
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 index (1-based)
Items per page
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 by end_date. Same keyword/static-range syntax as filter[start_date_range].
Filter by the booking's active period (overlap between start_date and end_date). Same keyword/static-range syntax as filter[start_date_range].
One or more resource IDs. Use repeated-bracket form (filter[resources][]=155930) or a comma-separated list.
One or more resource group IDs.
One or more service IDs.
One or more booking statuses.
requested, accepted, declined, canceled, expired, completed Filter by community IDs (customers that belong to at least one of these communities).
Only return bookings that have at least one of the given add-on IDs.
Only return bookings that have at least one test result for one of the given test IDs.
Filter by test result values.
Filter by customer email (exact match).
Full-text search across booking number, description, customer name and email.
Exclude blocker bookings from the result set.
Only return bookings whose end_date is in the future.
Only return bookings whose end_date is in the past.
Only return bookings that have at least one associated test result.
Exclude sub-bookings (bookings that belong to a parent booking) from the result set.
Exclude the series master bookings of recurring series; individual occurrences are still returned.
Sort field. Prefix with - for descending. Common values: period, -period, start_date, -start_date, created_at, -created_at, status.
Comma-separated list of booking attributes to return.
Comma-separated list of resource attributes to return for included resources.
Comma-separated list of order attributes to return for included orders.
Comma-separated list of customer attributes to return for included customers.
Comma-separated list of service attributes to return for included services.
When 1, omit the test-result meta block from the response to reduce payload size.
Organization ID
Antwort
OK
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 expirationrequested— needs manual acceptance by adminaccepted— accepted (automatically or manually)rejected— rejected by admin before fulfillment; always yields a 100% refund when payment existscanceled— canceled by customer or admin; refund follows the configured cancellation policy conditionsexpired— booking expired because the check-in time passed without check-in