APapaleo
Unit

Get a unit

Get a unit by id.<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.<br>For fine-grained clients, you must have this permission: 'core.units.read'.

get/inventory/v1/units/{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/inventory/v1/units/{id}
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: units.read, setup.read, setup.manage, admin

Path parameters

idstring required

The id of the unit.

Query parameters

languagesstring[]

'all' or comma separated list of two-letter language codes (ISO Alpha-2)

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 the unit data.

idstring required

The unit id

namestring required

The name for the unit

descriptionobject required

The description for the unit

maxPersonsinteger required

Maximum number of persons for the unit

createdstring date-time required

Date of creation<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>

archivedstring date-time nullable

Date when the unit was archived<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>

isArchivedboolean

Indicates whether the unit is archived. A unit is archived if the Archived property has a value.

Example response

{
  "id": "MUC-MTA",
  "name": "A.101",
  "description": {
    "en": "First Floor Room 1",
    "de": "1.OG Zimmer 1"
  },
  "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-MTA-SGHZD",
      "from": "2026-10-23T13:50:37.1321675+02:00",
      "to": "2026-10-25T12:50:37.1321675+01:00",
      "type": "OutOfService",
      "description": "The remote control for the TV needs to be replaced."
    }
  },
  "maxPersons": 2,
  "created": "0001-01-01T00:00:00Z",
  "isArchived": false,
  "attributes": [
    {
      "id": "KQOSXHLS",
      "name": "Floor 3",
      "description": "Floor number"
    },
    {
      "id": "ADVFSSUL",
      "name": "Street view",
      "description": "View from the room"
    }
  ],
  "connectedUnits": []
}

Changes

No recorded changes to this operation across all 4 revisions of this API.