---
title: "Get all unit groups, or all unit groups for a property"
method: GET
path: "/inventory/v1/unit-groups"
tags: ["UnitGroup"]
---

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

`GET /inventory/v1/unit-groups`

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

## Query parameters

- `propertyId` string
- `unitGroupTypes` string[]
- `pageNumber` integer
- `pageSize` integer
- `expand` string[]

## Response `200`

Return all unit groups.

- UnitGroupListModel
  - `unitGroups` UnitGroupItemModel[], required — List of unit groups
    - `id` string, required — The unit group id
    - `code` string, required — The code for the unit group that can be shown in reports and table views
    - `name` string, required — The name for the unit group
    - `description` string, required — The description for the unit group
    - `memberCount` integer, required — Number of units in this group
    - `maxPersons` integer — Maximum number of persons for the unit group
    - `rank` integer, nullable — The unit group rank
    - `type` 'BedRoom' | 'MeetingRoom' | 'EventSpace' | 'ParkingLot' | 'Other', required — The unit group type
    - `property` EmbeddedPropertyModel, required
      - `id` string, required — The property id
      - `code` string, nullable — The code for the property that can be shown in reports and table views
      - `name` string, nullable — The name for the property
      - `description` string, nullable — The description for the property
    - `connectedUnitGroups` ConnectedUnitGroupModel[], nullable — The list of connected unit groups this unit group is composed of
      - `id` string, required — The unit group id
      - `name` string, required — The name for the unit group
      - `description` string, required — The description for the unit group
      - `memberCount` integer, required — The number of units taken from this connected unit group
      - `maxPersons` integer — Maximum number of persons for the unit group
  - `count` integer, required — Total count of items

## Other responses

- `204` — There are no unit groups found.
- `400` — Bad request.
- `401` — You are unauthorized.
- `403` — Forbidden.
- `404` — The Request-URI could not be found.
- `422` — Validation errors in the request body or query params.
- `499` — Client closed request.
- `500` — An unexpected error occurred.
- `503` — The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-inventory-api.md) · [All operations](https://skmtc.dev/apaleo/apis/apaleo-inventory-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/apaleo/apaleo-inventory-api/revisions/a2846f52cdfb/schema)