Skip to main content
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.000Z
string
End of the booking date range. Required when StartDate is provided.Format: yyyy-MM-ddTHH:mm:ss.fffZ
string
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.fffZ
boolean
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.
You must provide either StartDate + EndDate or UpdatedFromDate + UpdatedToDate. Mixing date filter types, or omitting both, will return an empty result set without an error response.

Response

integer
Total number of bookings returned in this response.
array
List of booking objects.

Examples

Example Response


Status Codes

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

API Key authentication header

Query Parameters

ServiceName
string

The Service Name.

StartDate
string

The Booking Start Date. Format: 'yyyy-MM-ddTHH:mm:ss.fffZ'

EndDate
string

The Booking End Date. Format: 'yyyy-MM-ddTHH:mm:ss.fffZ'

UpdatedFromDate
string

The Booking Updated From Start Date. Format: 'yyyy-MM-ddTHH:mm:ss.fffZ'

UpdatedToDate
string

The Booking Updated To End Date. Format: 'yyyy-MM-ddTHH:mm:ss.fffZ'

IncludeCustomerDetails
boolean

Set true to include customer details in the Bookings object.

IncludeCancelledBookings
boolean

Set False to exclude Bookings that are in Cancelled status. Default: True.

Response

Gets Bookings

bookings
object[] | null
count
integer<int32>