Get all bookings
Get a list of all bookings. A booking is a customer reservation for one or more service time slots - for example, an appointment, an event registration, or a table reservation. Use filters such as customer_id and booking_status to narrow results. Set add_booking_items to include the individual time slot reservations in the response.
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
Direction of sorting the response list.
The unique ID of the customer. GET /customers
This query parameter is deprecated, please use parameter booking_statuses.
List of current statuses of the bookings from resource GET /booking-statuses. In case you want to filter multiple options use array syntax : booking_statuses[]=a820c6a820c62c79b2c79b&booking_statuses[]=b930d7b930d73d80c3d80c Logic OR is used between values.
Booking items are going to be return depends on the parameter value. Possible values: full - returns all booking items with their additional properties. / items-only - returns all booking items without additional properties. / none or no value - return no booking items
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"bookings": [
{
"booking_id": "83d0ce2b5a1bc0dc8da01b13e7",
"customer_id": "85bc5819e09dab95437552ce79",
"booking_items": [
{
"booking_item_id": "8fd73167342d0689c4c015320",
"customer_id": "8ea6abece4cd0a4ded0a29f093",
"time_slot_id": "88bb88399cc74d81edbe19d684",
"booking_ticket": {
"ticket_id": "89d88719b8b442de2d11b401a2",
"name": "Prophecy",
"created_at": "2022-07-26 11:38:22",
"state": 1,
"last_change": "2022-09-16 16:14:41"
},
"valid_from": "2022-01-09 22:00:00",
"valid_to": "2022-01-09 22:30:00",
"capacity_taken": 2,
"booking_item_status": "86e05affc7a7abefcd513ab400",
"additional_properties": [
{
"property_record_id": "docasna_blokace_darce_do:8ea2591121e636086a4a9c0992",
"property_id": "docasna_blokace_darce_do",
"property_name": "Property #6",
"last_change": "2023-02-02 00:00:00"
}
],
"created_at": "2017-06-20 16:59:49",
"state": 1,
"last_change": "2013-07-24 21:33:33"
}
],
"booking_status": "81eaeea13b8984a169c490a325",
"utm": {
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "spring_sale"
},
"created_at": "2022-08-11 11:15:33",
"last_change": "2022-08-11 11:15:33",
"state": 1
}
],
"total_items": 1
}
}