---
title: "Get a list of all available units in a property"
method: GET
path: "/availability/v1/units"
tags: ["Availability"]
---

# Get a list of all available units in a property

`GET /availability/v1/units`

Get the list of available units for a specific property and time period.<br>You must have this scope: 'availability.read'.

## Query parameters

- `propertyId` string, required
- `unitGroupId` string
- `from` string, date-time, required
- `to` string, date-time, required
- `includeOutOfService` boolean
- `unitCondition` 'Clean' | 'CleanToBeInspected' | 'Dirty'
- `unitAttributeIds` string[]
- `pageNumber` integer
- `pageSize` integer

## Response `200`

Return all available units.

- AvailableUnitListModel
  - `units` AvailableUnitItemModel[], required — List of units
    - `id` string, required — The unit id
    - `name` string, required — The name for the unit
    - `description` string, required — The description for the unit
    - `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
    - `unitGroup` EmbeddedUnitGroupModel
      - `id` string, required — The unit group id
      - `code` string, nullable — The code for the unit group that can be shown in reports and table views
      - `name` string, nullable — The name for the unit group
      - `description` string, nullable — The description for the unit group
      - `type` 'BedRoom' | 'MeetingRoom' | 'EventSpace' | 'ParkingLot' | 'Other', nullable — The unit group type
    - `status` AvailableUnitItemStatusModel, required
      - `isOccupied` boolean, required
      - `condition` 'Clean' | 'CleanToBeInspected' | 'Dirty', required
      - `maintenanceType` 'OutOfService' | 'OutOfOrder' | 'OutOfInventory', nullable
    - `maxPersons` integer, required — Maximum number of persons for the unit
    - `attributes` UnitAttributeModel[], nullable — Collection of user defined attributes of unit
      - `id` string, required — Id of unit attribute
      - `name` string, required — The name of the unit attribute
      - `description` string, nullable — Description of unit attribute
  - `count` integer, required — Total count of items

## Other responses

- `204` — There are no available units matching your criteria.
- `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-availability-api.md) · [All operations](https://skmtc.dev/apaleo/apis/apaleo-availability-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/apaleo/apaleo-availability-api/revisions/efbf2d427dd7/schema)