Apaleo Official icon

Apaleo Official

Interact with Apaleo API

Actions5

Availability → Get Available Units

AI-generated

Summary

Retrieves available units for a property over a specified time period by sending a GET request to /availability/v1/units.

Inputs

  • Property ID (required) — The Apaleo property ID.
  • From (required) — Start date and time in ISO 8601 format.
  • To (required) — End date and time in ISO 8601 format.
  • IncludeOutOfService — Whether to include units marked out of service during the requested period; defaults to false.
  • PageNumber — Page to retrieve; defaults to 1.
  • PageSize — Items per page; the API default is 20 and the maximum is 200.
  • UnitAttributeIds — One or more unit attribute IDs to filter the results.
  • UnitCondition — Filter by unit condition: Clean, CleanToBeInspected, or Dirty. Defaults to Clean.
  • UnitGroupId — Filter by unit group ID.

Output shape

A response from the Apaleo availability API containing the available units for the requested property and time range.

The API may return HTTP 204 No Content when the requested page has no items. The provided source pack contains no executable method body, so the exact response structure is not shown.

Links

Discussion