getTimeSlots( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns a list of time slots at a given reservation location on a given date, and their availability for a given partySize.

Without passing optional parameters, the list will contain a single time slot at the given date. Use slotsBefore and slotsAfter to get additional time slots before and after the given date.

If you do not provide a duration, the duration will be calculated automatically based on the reservation location's configuration. The reservation location's settings used to determine the duration are its defaultTurnoverTime and turnoverTimeRules. These specify how much time should be allotted for a reservation of a party of a given size.

The interval between startDates of time slots in the response is determined by the reservation location's timeSlotInterval. This interval is not affected by the duration provided.

Permissions
Manage Reservations (Basic)
Manage Reservations (Full)
Manage Reservations (Medium)
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
reservationLocationIdstringRequired

ID of the reservation location for which to retrieve time slots.


dateDateRequired

Date and time for which to retrieve a time slot in ISO 8601 format.


partySizenumberRequired

Size of the party that needs to be seated during this time slot.

Min: 1


optionsGetTimeSlotsOptions

Options for retrieving the time slots.

Returns
Return Type:Promise<GetTimeSlotsResponse>
Did this help?