Unit

Get a units list

Get the list of units.<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.

get/inventory/v1/units

Query parameters

propertyIdstring

Return units for specific property

unitGroupIdstring

Return units for the specific unit group - <b>DEPRECATED: This property will be removed 20.04.2022. Use UnitGroupIds instead</b>

unitGroupIdsstring[]

Return units with the specific unit groups

unitAttributeIdsstring[]

Return units with the specific unit attributes

isOccupiedboolean

Return only occupied or vacant units

maintenanceType'OutOfService' | 'OutOfOrder' | 'OutOfInventory'

Return units with the specific maintenance type

condition'Clean' | 'CleanToBeInspected' | 'Dirty'

Return units with a specific condition

textSearchstring

This will filter all units where the provided text is contained in the unit name. The search is case insensitive.

status'Active' | 'Archived' | 'All'

Return active units, archived units, or all units. Defaults to active.

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.

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: property, unitGroup, connectedUnits, actions. All other values will be silently ignored.

Response

Return all 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"
      },
      "connectingUnit": {
        "id": "MUC-QKY",
        "name": "S.101",
        "description": "Suite room",
        "unitGroupId": "MUC-SUI"
      },
      "status": {
        "isOccupied": true,
        "condition": "Dirty",
        "maintenance": {
          "id": "MUC-MTA-SGHZD",
          "type": "OutOfService"
        }
      },
      "maxPersons": 1,
      "created": "0001-01-01T00:00:00Z",
      "isArchived": false,
      "attributes": [
        {
          "id": "GRTDTLDD",
          "name": "Floor 2",
          "description": "Floor number"
        },
        {
          "id": "KQOSXHLS",
          "name": "Street view",
          "description": "View from the room"
        }
      ],
      "connectedUnits": []
    },
    {
      "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"
      },
      "connectingUnit": {
        "id": "MUC-QKY",
        "name": "S.101",
        "description": "Suite room",
        "unitGroupId": "MUC-SUI"
      },
      "status": {
        "isOccupied": false,
        "condition": "Clean",
        "maintenance": {
          "id": "MUC-JQI-GSZGK",
          "type": "OutOfOrder"
        }
      },
      "maxPersons": 2,
      "created": "0001-01-01T00:00:00Z",
      "isArchived": false,
      "attributes": [
        {
          "id": "GRTDTLDD",
          "name": "Floor 2",
          "description": "Floor number"
        }
      ],
      "connectedUnits": []
    },
    {
      "id": "MUC-QKY",
      "name": "S.101",
      "description": "Suite room",
      "property": {
        "id": "MUC",
        "code": "MUC",
        "name": "Demo Hotel Munich",
        "description": "This is the demo hotel Munich"
      },
      "unitGroup": {
        "id": "MUC-SUI",
        "code": "SUI",
        "name": "Suite",
        "description": "Suite",
        "type": "BedRoom"
      },
      "status": {
        "isOccupied": false,
        "condition": "Clean",
        "maintenance": {
          "id": "MUC-JQI-GSZGK",
          "type": "OutOfOrder"
        }
      },
      "maxPersons": 3,
      "created": "0001-01-01T00:00:00Z",
      "isArchived": false,
      "attributes": [
        {
          "id": "GRTDTLDD",
          "name": "Floor 2",
          "description": "Floor number"
        }
      ],
      "connectedUnits": [
        {
          "id": "MUC-MTA",
          "name": "A.101",
          "description": "Single room",
          "unitGroupId": "MUC-SGL",
          "condition": "Clean",
          "maxPersons": 1
        },
        {
          "id": "MUC-JQI",
          "name": "A.102",
          "description": "Double room",
          "unitGroupId": "MUC-DBL",
          "condition": "Clean",
          "maxPersons": 2
        }
      ]
    }
  ],
  "count": 3
}

Changes

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