---
title: "Get a list of all available units for a reservation"
method: GET
path: "/availability/v0-nsfw/reservations/{id}/units"
tags: ["ReservationAvailability"]
---

# Get a list of all available units for a reservation

`GET /availability/v0-nsfw/reservations/{id}/units`

## 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/availability/v0-nsfw/reservations/{id}/units`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`
  - Scopes: `availability.read`, `reservations.manage`, `admin`

Get the list of available units for a specific reservation and time period.<br>You must have at least one of these scopes: 'availability.read, reservations.manage'.<br>For fine-grained clients, you must have this permission: 'core.reservations_availability.read'.

## Path parameters

- `id` string, required

## Query parameters

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

## Response `200`

Return all available units for the reservation.

- 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-not-safe-for-work.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-availability-api-not-safe-for-work/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-availability-api-not-safe-for-work/revisions/8f035719b7d7?raw)