Sign in
Availability

Get house-level overbooking for a given property.

<br>You must have this scope: 'availability.read'.

get/availability/v1/properties/{id}

Path parameters

idstring required

The ID of the property.

Query parameters

fromstring date required

The first day of the time period from which availability will be modified.

tostring date required

The last day of the time period until which availability will be modified.

timeSliceTemplate'DayUse' | 'OverNight' required

The time slice template.

unitGroupType'BedRoom' | 'MeetingRoom' | 'EventSpace' | 'ParkingLot' | 'Other' required

The unit group type.

Response

OK

countinteger required

Total count of items

Example response

{
  "timeSlices": [
    {
      "from": "2025-01-01T00:00:00Z",
      "to": "2025-01-02T00:00:00Z",
      "houseOverbookingLimit": 5
    },
    {
      "from": "2025-01-04T00:00:00Z",
      "to": "2025-01-05T00:00:00Z",
      "houseOverbookingLimit": 5
    }
  ],
  "count": 2
}

Changes

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