Sign in
Availability

Get a list of all available units in a property

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

get/availability/v1/units

Query parameters

propertyIdstring required

The property id

unitGroupIdstring

The unit group id

fromstring date-time required

The from date and time<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

tostring date-time required

The to date and time<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

includeOutOfServiceboolean

Should units that are set OutOfService in the defined time period be returned as available.

unitCondition'Clean' | 'CleanToBeInspected' | 'Dirty'

The unit condition

unitAttributeIdsstring[]

Return units with the specific unit attributes

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 units.

countinteger required

Total count of items

Example response

{
  "units": [
    {
      "id": "MUC-MTA",
      "name": "A.101",
      "description": "Single room",
      "property": {
        "id": "MUC",
        "code": "MUC",
        "name": "Demo Hotel Munich",
        "description": "This is the demo hotel Munich"
      },
      "unitGroup": {
        "id": "MUC-SGL",
        "code": "SGL",
        "name": "Single",
        "description": "Single",
        "type": "BedRoom"
      },
      "status": {
        "isOccupied": true,
        "condition": "Dirty",
        "maintenanceType": "OutOfService"
      },
      "maxPersons": 1,
      "attributes": [
        {
          "id": "KQOSXHLS",
          "name": "Floor 1",
          "description": "Floor number"
        },
        {
          "id": "ADVFSSUL",
          "name": "Street view",
          "description": "View from the room"
        }
      ]
    },
    {
      "id": "MUC-JQI",
      "name": "A.102",
      "description": "Double room",
      "property": {
        "id": "MUC",
        "code": "MUC",
        "name": "Demo Hotel Munich",
        "description": "This is the demo hotel Munich"
      },
      "unitGroup": {
        "id": "MUC-DBL",
        "code": "DBL",
        "name": "Double",
        "description": "Double",
        "type": "BedRoom"
      },
      "status": {
        "isOccupied": false,
        "condition": "Clean"
      },
      "maxPersons": 2,
      "attributes": [
        {
          "id": "KQOSXHLS",
          "name": "Floor 1",
          "description": "Floor number"
        }
      ]
    }
  ],
  "count": 2
}

Changes

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