Apaleo Official icon

Apaleo Official

Interact with Apaleo API
Join our community

Actions5

Overview

This node operation retrieves a list of all available units within a specified property for a given time range. It is useful in scenarios where you need to check unit availability, such as hotel rooms or rental properties, to manage bookings, inventory, or operations efficiently.

Practical examples include:

  • Fetching available rooms in a hotel for a specific date range to display on a booking platform.
  • Checking which units are out of service during a maintenance period.
  • Filtering units by condition (e.g., clean, dirty) to coordinate housekeeping schedules.

Properties

Name Meaning
Group Selects the API group to use; here it should be "AvailabilityV1" for this operation.
PropertyId The unique identifier of the property for which to retrieve available units.
From The start date and time (in ISO8601 format) from which to check unit availability.
To The end date and time (in ISO8601 format) until which to check unit availability.
Additional Fields A collection of optional parameters to refine the query:
- IncludeOutOfService Boolean flag indicating whether units marked as OutOfService during the time period should be included as available.
- PageNumber The page number for paginated results (1-based). Defaults to 1. If no items exist on the requested page, a 204 response is returned.
- PageSize Number of items per page. If not set or non-positive, pagination is ignored and all items are returned.
- UnitAttributeIds Filter units by specific attribute IDs (comma-separated string).
- UnitCondition Filter units by their condition status. Options are: Clean, CleanToBeInspected, Dirty.
- UnitGroupId Filter units belonging to a specific unit group ID.

Output

The output JSON contains an array of unit objects representing the available units matching the query criteria. Each unit object typically includes details such as unit ID, attributes, condition, group membership, and availability status.

If the node supports binary data output (not indicated here), it would represent associated files or media related to units, but this operation primarily returns structured JSON data about units.

Dependencies

  • Requires an API authentication token configured in n8n credentials to access the Apaleo API.
  • The base URL for requests is https://api.apaleo.com.
  • The node uses HTTP GET requests with query parameters constructed from input properties.

Troubleshooting

  • Empty Results / 204 No Content: If requesting a page number beyond available pages, the API returns 204. Adjust the PageNumber or remove pagination to get results.
  • Invalid Date Format: Ensure From and To dates are valid ISO8601 strings without fractional seconds, as required by the API.
  • Missing Required Fields: PropertyId, From, and To are mandatory. Omitting them will cause errors.
  • API Authentication Errors: Verify that the API key or OAuth2 token is correctly configured and has sufficient permissions.
  • Filtering Issues: Using invalid UnitCondition values or malformed UnitAttributeIds may result in no matches or errors.

Links and References

Discussion