Skip to main content
The availability endpoint returns a list of every date in a given month and whether each date has at least one bookable slot for the requested party size. Use this to power your booking calendar: highlight available dates in green and grey out unavailable ones before the guest picks a day.

Endpoint

No authentication is required.

Path parameters

string
required
The public token for the restaurant.

Query parameters

string
required
The month to check, in YYYY-MM format. For example, 2025-05 for May 2025.
number
required
The number of guests in the party. A date is only marked available: true if there is at least one open slot with enough remaining capacity for this party size.

Response fields

string
required
The month that was queried, echoed back in YYYY-MM format.
number
required
The party size that was queried, echoed back.
object[]
required
Array of date availability objects, one per calendar day in the requested month.
A date is marked available: true only when there is at least one slot with remaining_capacity greater than or equal to the requested guests value. Use GET Time Slots to fetch the individual slots for a specific date.

Example