Skip to content

List Availability

GET
/venues/{venueId}/availability

Lists availability for the Venue for the specified numberOfDays starting with fromDate. The availability for a Venue are described on two levels; venueStatus and reservableState. The former describes if a venue is open for business, while the latter describes if it is possible to create any bookings on at least one scenario right now.

A maximum of 31 days are returned with 1 being the default if nothing is specified. If no fromDate is specified it will default to the current date.

venueStatus

State Description
OPEN The Venue is open for business. This does not however mean that there are available scenarios to book from.
CLOSED The Venue is closed, either because of planned opening hours or because an opening hour deviation has occured (temporary closed).

reservableState

State Description
AVAILABLE The Venue has one or more scenarios which are open and have available TimeSlots.
NOT_AVAILABLE All of the scenarios for the Venue are NOT_AVAILABLE.
FULLY_BOOKED One or more scenarios are FULLY_BOOKED and there are no AVAILABLE scenarios.

scenarios[].status

State Description
AVAILABLE The Scenario has available capacity.
NOT_AVAILABLE The bookable capacity is either set to 0, no tables have been defined, or the Scenario is temporarily blocked for booking.
FULLY_BOOKED The Scenario has no available capacity.

Authorizations

OAuth2
clientCredentials Flow
Token URL"https://login.microsoftonline.com/{issuer}/oauth2/v2.0/token"
Scopes:
or
X-API-KEY

Is made available as part of the onboading/integration process.

Type
API Key (header: X-API-KEY)

Parameters

Query Parameters

fromDate

Date in ISO-8601 format YYYY-MM-DD. Defaults to todays date if nothing else is specified.

Type
string
Example"2023-01-01"
Format
"date"
days

Number of days to return.

Type
integer
Example14
Format
"date"
Minimum
1
Maximum
31
Default
1
guestCount

Number of guests.

Type
integer
Default
1
reservableState

Filter response by reservableState value.

Type
string
Valid values
"AVAILABLE""NOT_AVAILABLE""FULLY_BOOKED"
venueStatus

Filter response by venueStatus value.

Type
string
Valid values
"OPEN""CLOSED"
scenarioId

Filter response by scenarioId.

Type
string

Responses

application/json
JSON
{
"data": [
{
"date": "2024-07-28",
"venueStatus": "string",
"reservableState": "string",
"scenarios": [
{
"id": 0,
"displayName": "string",
"status": "string"
}
]
}
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

Technical documentation for partners and integrators