List Bookings
Bookings
List Bookings
Retrieve a list of bookings with optional filters for date range, service, and customer details
GET
List Bookings
string
required
Your partner API key. Contact [email protected] to obtain one.
Query Parameters
string
Filter bookings by service name (e.g.,
"Dinner", "Lunch").string
Start of the booking date range. Required when
EndDate is provided.Format: yyyy-MM-ddTHH:mm:ss.fffZExample: 2024-06-01T00:00:00.000Zstring
End of the booking date range. Required when
StartDate is provided.Format: yyyy-MM-ddTHH:mm:ss.fffZstring
Start of the last-modified date range. Required when
UpdatedToDate is provided.Format: yyyy-MM-ddTHH:mm:ss.fffZUse this pair to poll for changes since your last sync.string
End of the last-modified date range. Required when
UpdatedFromDate is provided.Format: yyyy-MM-ddTHH:mm:ss.fffZboolean
default:"false"
When
true, each booking object will include a nested customer object with the guest’s contact details.boolean
default:"true"
When
false, cancelled bookings are excluded from results.Response
integer
Total number of bookings returned in this response.
array
List of booking objects.
Examples
Example Response
Status Codes
Authorizations
Headers
API Key authentication header
Query Parameters
The Service Name.
The Booking Start Date. Format: 'yyyy-MM-ddTHH:mm:ss.fffZ'
The Booking End Date. Format: 'yyyy-MM-ddTHH:mm:ss.fffZ'
The Booking Updated From Start Date. Format: 'yyyy-MM-ddTHH:mm:ss.fffZ'
The Booking Updated To End Date. Format: 'yyyy-MM-ddTHH:mm:ss.fffZ'
Set true to include customer details in the Bookings object.
Set False to exclude Bookings that are in Cancelled status. Default: True.