APapaleo
Availability

Get house-level overbooking for a given property.

<br>You must have this scope: 'availability.read'.<br>For fine-grained clients, you must have this permission: 'core.properties_availability.read'.

get/availability/v0-nsfw/properties/{id}

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/availability/v0-nsfw/properties/{id}
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: availability.read, admin

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 operation across all 2 revisions of this API.