Sign in

v1

latestOpenAPI 3.0.32026-07-2672165314.6 KB
Availability

Retrieves availability information for all room types within a specific property for a given date range.

Retrieves availability information for all room types within a specific property for a given date range.

get/v1/availability/{propertyId}

Path parameters

propertyIdinteger required

The unique identifier of the property.

Query parameters

periodStartstring date-time

The start date of the period to check availability.

periodEndstring date-time

The end date of the period to check availability.

CombineRoomTypesboolean

Indicates whether to combine results from different room types into a single house total

BookingsOnlyboolean

Indicates whether to retrieve only booking information, excluding other availability details. This option is only valid for room type queries

IncludeBookingIdsboolean

Indicates whether to include the list of booking identifiers in the response. This option is only valid for room type queries

ModifiedSincestring date-time

Filters the results to include only sub-periods modified after the specified date, up to 6 months prior to the current date. This option is only valid for room type queries

Response

OK

property_idinteger

The unique identifier of the property associated with this availability period

room_type_idinteger

The unique identifier of the room type

period_startstring date-time

The start date of the availability period

period_endstring date-time

The end date of the availability period (inclusive)

availableinteger

The number of units available during this period

total_unitsinteger

The total number of units for this room type

total_overbookedinteger

The total number of overbooked units for this room type

is_availableboolean

Indicates whether the period is available (not closed and has unoccupied units)

booking_idsinteger[] nullable

The list of booking identifiers associated with this period

closed_period_idinteger nullable

The identifier of the closed period, if applicable