Skip to main content
GET
Get availability
Ask what a venue can seat, then take the serviceId, sectionId and option ids straight into Create a Reservation.

Authorizations

Authorization
string
header
required

Your API key. See Authorization to create one.

Path Parameters

venueId
string
required

The venue being addressed. Every endpoint on this API is venue-scoped.

Minimum string length: 1
Example:

"6247"

Query Parameters

startDate
string
required

Window start. A bare ISO date (2026-09-01) means the whole day; a full local ISO datetime (2026-09-01T18:00:00) means that exact time. Venue-local wall clock — do not send a Z suffix or an offset. A range entirely in the past is rejected with 400, judged against the venue's own calendar date. Where the venue sets a minimum notice period, the window simply starts no sooner than that.

Example:

"2026-09-01"

endDate
string

Window end, inclusive. Same two forms as startDate, and the two can mix. Defaults to startDate, so a bare startDate on its own returns that whole day. Send the same datetime for both to ask about one slot.

Example:

"2026-09-03"

partySize
integer
required

Number of guests. Integer, at least 1. A party over the venue's maximum is rejected with 400.

Required range: x >= 1
Example:

2

serviceId
string

Restrict the response to one service or event, by id. Every dated occurrence of that service in the range is kept.

Example:

"service_dinner"

sectionId
string

Restrict each service's availableSections to one section. A service that does not offer the section is dropped entirely rather than returned with an empty section list.

Example:

"section_main"

includeDiaryOnlyTables
boolean

Include tables the venue keeps for its own diary bookings. true includes them; absent or false uses your integration's default.

Response

One entry per venue calendar day in the window.

venueId
string
required

The venue this day belongs to.

date
string<date>
required

The venue's own calendar date, not a UTC one.

isVenueOpen
boolean
required

True when at least one service is bookable on this day.

availableServices
object[]
required

The services bookable on this day. Empty when the venue is closed or nothing can seat the party.