Propertys

Get Property Availability

Get availability for a property across a date range.

Returns per-date availability combining inventory and restriction data. If room_type_id is provided, returns availability for that specific room type. Otherwise, returns aggregated availability across all room types.

Guest counts (adults, children, infants) are used to calculate adjusted rates that include extra guest charges based on the rate plan's guest pricing.

For site room types, equipment_length and equipment_width can be provided to filter availability to only sites that can accommodate the equipment dimensions.

For RMS properties, equipment_type triggers dwelling-type compatibility checking. Site categories whose RMS dwelling allocations do not include the guest's equipment type are excluded (equipment_type_excluded=true).

get/properties/{property_id}/availability

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/properties/{property_id}/availability
  • Auth: none declared

Path parameters

property_idinteger required

Query parameters

start_datestring date required

Start date for availability check

end_datestring date required

End date for availability check

room_type_idinteger nullable

Filter by specific room type

adultsinteger

Number of adults

childreninteger

Number of children

infantsinteger

Number of infants

equipment_lengthnumber nullable

Equipment length in metres (for site filtering)

equipment_widthnumber nullable

Equipment width in metres (for site filtering)

equipment_typestring nullable

Canonical equipment type (e.g. 'caravan', 'motorhome') for RMS compatibility filtering

country'AU' | 'NZ'

ISO country code used to scope public property inventory.

Headers

X-Conversion-Attempt-IDstring nullable
API-Version'1'

Major API version. Omit or send 1 for the current v1 surface. Retired operations use RFC 9745 Deprecation and RFC 8594 Sunset headers.

Response

Successful Response

msgstring required

Changes

No recorded changes to this operation across all 1 revision of this API.