List bookings
list_bookingsRetrieve bookings filtered by date range, status, service, resource, customer, or booking IDs, returning details like times, price, and participants.
Instructions
Bookings with status, service, resource, times, price, spaces and participants (customer IDs, spaces, arrival status, source). Filter by a date range (after/before compare with the booking's start/end including buffers), creation or update time, status, service, category, resource, customer or booking IDs. Participants carry customer_id only; use get_customer for names. Customers' free-text answers and single-use reschedule links are withheld unless include_contact_details is set.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| after | No | Only bookings that start at or after this date/time (ISO 8601) | |
| start | No | ID of the first booking of the page to return: the next_start of a previous call | |
| before | No | Only bookings that end at or before this date/time (ISO 8601) | |
| status | No | Only bookings with this status (the API's statuses parameter, typed as one value) | |
| sort_by | No | Sort property (the API defaults to natural) | |
| order_by | No | Sort direction (the API defaults to descending) | |
| timezone | No | IANA timezone to return every date and time in; the documentation gives no default for this endpoint (its example shows +00:00 offsets) | |
| booking_ids | No | Only these bookings (the API's ids filter); the API has no single-booking endpoint, so use this to fetch one booking | |
| max_results | No | Maximum number of bookings to return | |
| service_ids | No | Only bookings for these services | |
| category_ids | No | Only bookings whose service is in one of these categories | |
| customer_ids | No | Only bookings with one of these customers on them | |
| resource_ids | No | Only bookings for these resources | |
| created_after | No | ||
| updated_after | No | ||
| created_before | No | ||
| updated_before | No | ||
| include_contact_details | No | Include participants' question answers as stored, and each participant's single-use reschedule link | |
| return_matching_customers_only | No | The API's return_matching_customers_only flag: only list the participants whose customer IDs were given in the filter (useful for large group bookings) |