Sign in
UnitGroup

Get all unit groups, or all unit groups for a property

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

get/inventory/v1/unit-groups

Query parameters

propertyIdstring

Return unit groups for specific property

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

Response

Return all unit groups.

countinteger required

Total count of items

Example response

{
  "unitGroups": [
    {
      "id": "MUC-DBL",
      "code": "DBL",
      "name": "Double Room",
      "description": "This is a nice room with as kingsize bed and flat screen",
      "memberCount": 2,
      "maxPersons": 4,
      "rank": 2,
      "type": "BedRoom",
      "property": {
        "id": "MUC",
        "code": "MUC",
        "name": "Demo Hotel Munich",
        "description": "This is the demo hotel Munich"
      }
    },
    {
      "id": "BER-SUIT",
      "code": "SUIT",
      "name": "Suite Room",
      "description": "This is a nice suite with two rooms combined",
      "memberCount": 1,
      "maxPersons": 3,
      "rank": 1,
      "type": "BedRoom",
      "property": {
        "id": "BER",
        "code": "BER",
        "name": "Demo Hotel Berlin",
        "description": "This is the demo hotel Berlin"
      },
      "connectedUnitGroups": [
        {
          "id": "BER-SGL",
          "name": "Single room",
          "description": "This is a nice room with a single bed",
          "memberCount": 2,
          "maxPersons": 1
        },
        {
          "id": "BER-DBL",
          "name": "Double room",
          "description": "This is a nice room with as kingsize bed and flat screen",
          "memberCount": 1,
          "maxPersons": 2
        }
      ]
    }
  ],
  "count": 0
}

Changes

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