Sign in
Availability

Get a list of all available unit groups in a property

Get the list of available unit groups for a specific property and time period.<br>You must have this scope: 'availability.read'.

get/availability/v1/unit-groups

Query parameters

propertyIdstring required

The property id

fromstring date required

First day of the requested time period. The given day will be included in the response.

tostring date required

Last day of the requested time period. The given day will be included in the response.

timeSliceTemplate'DayUse' | 'OverNight'

The time slice template, defaults to 'over night'

unitGroupTypesstring[]

Filter result by requested unit group types

timeSliceDefinitionIdsstring[]

The time slice definition ids

unitGroupIdsstring[]

The unit group ids

adultsinteger

The number of adults you want availability for, defaults to 1

childrenAgesinteger[]

The ages of the children you want availability for

onlySellableboolean

When set to 'true', only the unit groups sold by the specified time slice template and time slice definition ids are returned, otherwise all unit groups are returned

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

Response

Return all available unit groups.

countinteger required

Total count of items

Example response

{
  "timeSlices": [
    {
      "from": "2026-09-01T17:00:00+02:00",
      "to": "2026-09-02T11:00:00+02:00",
      "property": {
        "physicalCount": 30,
        "houseCount": 26,
        "soldCount": 13,
        "occupancy": 50,
        "sellableCount": 9,
        "allowedOverbookingCount": 1,
        "houseOverbookingLimit": 2,
        "maintenance": {
          "outOfService": 2,
          "outOfOrder": 4,
          "outOfInventory": 4
        },
        "block": {
          "definite": 1,
          "tentative": 1,
          "optional": 1,
          "optionalDeducting": 1,
          "picked": 3,
          "remaining": 1
        }
      },
      "unitGroups": [
        {
          "unitGroup": {
            "id": "MUC-SGL",
            "code": "SGL",
            "name": "Single",
            "description": "Single",
            "type": "BedRoom"
          },
          "physicalCount": 10,
          "houseCount": 8,
          "soldCount": 3,
          "occupancy": 37.5,
          "availableCount": 0,
          "sellableCount": 3,
          "allowedOverbookingCount": 0,
          "maintenance": {
            "outOfService": 1,
            "outOfOrder": 2,
            "outOfInventory": 2
          },
          "block": {
            "definite": 2,
            "tentative": 5,
            "optional": 1,
            "optionalDeducting": 0,
            "picked": 1,
            "remaining": 2
          }
        },
        {
          "unitGroup": {
            "id": "MUC-DBL",
            "code": "DBL",
            "name": "Double",
            "description": "Double",
            "type": "BedRoom"
          },
          "physicalCount": 20,
          "houseCount": 18,
          "soldCount": 10,
          "occupancy": 55.55,
          "availableCount": 0,
          "sellableCount": 6,
          "allowedOverbookingCount": 1,
          "maintenance": {
            "outOfService": 1,
            "outOfOrder": 2,
            "outOfInventory": 2
          },
          "block": {
            "definite": 6,
            "tentative": 1,
            "optional": 2,
            "optionalDeducting": 1,
            "picked": 3,
            "remaining": 2
          }
        }
      ]
    }
  ],
  "count": 1
}

Changes

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