Apaleo Official icon

Apaleo Official

Interact with Apaleo API

Actions5

ReservationAvailability → Get Available Units For Reservation

AI-generated

Summary

Retrieves available units for a reservation by its ID, with optional date, condition, attribute, and unit group filters. Results can be requested in pages.

Inputs

  • Id (required) — Reservation ID used to request its available units.
  • From — Optional start date and time for the availability period.
  • To — Optional end date and time for the availability period.
  • IncludeOutOfService — Whether to include units marked out of service during the specified period; defaults to false.
  • UnitCondition — Filter by unit condition: Clean, CleanToBeInspected, or Dirty; defaults to Clean.
  • UnitAttributeIds — One or more unit attribute IDs to filter the returned units.
  • UnitGroupId — Filter by unit group ID.
  • PageNumber — Page to retrieve; defaults to 1. A page with no items may return 204 No Content.
  • PageSize — Items per page; defaults to 20, with a maximum of 200.

Output shape

A paginated list of available units for the reservation.

The API may return 204 No Content when the requested page has no items.

Links

Discussion