Apaleo Official icon

Apaleo Official

Interact with Apaleo API

Availability → Get Available Unit Groups

AI-generated

Summary

Retrieves available unit groups for a property over a date range from the Apaleo Availability API. You can filter the results by guest count, time slice, unit groups, and unit group types, and page through the response.

Inputs

  • Property ID (required) — The property whose availability to query.
  • From (required) — First date of the requested period, included in the response.
  • To (required) — Last date of the requested period, included in the response.
  • Adults — Number of adults; the API defaults to 1 when omitted.
  • Children ages — One or more child ages, sent as a comma-separated query value.
  • Only sellable — When enabled, limits results to unit groups sold by the specified time slice template and definition IDs.
  • Page number — Page to retrieve; defaults to 1.
  • Page size — Items per page; the API defaults to 20 and allows up to 200.
  • Time slice definition IDs — One or more time slice definition IDs, sent as a comma-separated query value.
  • Time slice template — Choose DayUse or OverNight; defaults to DayUse in the node UI.
  • Unit group IDs — One or more unit group IDs to filter by.
  • Unit group types — One or more unit group types to filter by.

Output shape

A paginated list of available unit groups returned by the Apaleo API.

The node source pack does not expose the response transformation or exact item schema. If the requested page has no items, the API may return 204 No Content.

Links

Discussion