APapaleo
UnitGroup

Get a unit group

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

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

Path parameters

idstring required

The id of the unit group.

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, connectedUnitGroups. All other values will be silently ignored.

Response

Return all the unit group data.

idstring required

The unit group id

codestring required

The code for the unit group that can be shown in reports and table views

nameobject required

The name for the unit group

memberCountinteger required

Number of units in this group

descriptionobject required

The description for the unit group

maxPersonsinteger required

Maximum number of persons for the unit group

rankinteger nullable

The unit group rank

type'BedRoom' | 'MeetingRoom' | 'EventSpace' | 'ParkingLot' | 'Other' required

The unit group type

Example response

{
  "id": "MUC-DBL",
  "code": "DBL",
  "property": {
    "id": "MUC",
    "code": "MUC",
    "name": "Demo Hotel Munich",
    "description": "This is the demo hotel Munich"
  },
  "name": {
    "en": "Double Room",
    "de": "Doppelzimmer"
  },
  "memberCount": 0,
  "description": {
    "en": "This is a nice room with as kingsize bed and flat screen",
    "de": "Dies ist ein schönes Zimmer mit Kingsize-Bett und Flachbildschirm"
  },
  "maxPersons": 4,
  "rank": 2,
  "type": "BedRoom"
}

Changes

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