Apaleo icon

Apaleo

Interact with Apaleo API

Overview

This node interacts with the Apaleo API, specifically to retrieve the count of booking blocks when using the "Block" resource with the "GET block count" operation. It allows users to filter blocks by various criteria such as property IDs, date ranges, and status. This is useful in scenarios where you need to monitor or report on the number of booking blocks that meet certain conditions, for example, to analyze availability or occupancy trends over time.

Practical examples:

  • Counting how many tentative blocks exist for a specific set of properties within a given date range.
  • Getting the total number of definite blocks created after a certain date.
  • Filtering blocks by status to understand cancellations.

Properties

Name Meaning
Property IDs Comma-separated list of property IDs to filter the blocks by.
From Date Start date to filter blocks from (inclusive).
To Date End date to filter blocks until (inclusive).
Status Filter blocks by their status. Options: Tentative, Definite, Canceled.

Output

The node outputs an array of JSON objects corresponding to each input item processed. For the "GET block count" operation, the output JSON contains the count of blocks matching the specified filters. The exact structure depends on the API response but typically includes a numeric count field indicating how many blocks matched the query.

No binary data output is involved in this operation.

Dependencies

  • Requires an API authentication token credential for Apaleo API access.
  • The node makes HTTP requests to the Apaleo API base URL https://api.apaleo.com.
  • Proper configuration of the API key/credential in n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Invalid or expired API token leading to authentication errors.
    • Incorrectly formatted property IDs or date filters causing API request failures.
    • Network connectivity problems preventing access to the Apaleo API.
  • Error messages:

    • Authentication errors usually indicate missing or invalid credentials; ensure the API token is correctly configured.
    • Validation errors from the API may occur if filter parameters are malformed; verify the format of property IDs and dates.
    • Timeout or network errors suggest connectivity issues; check your internet connection and firewall settings.

Links and References

Discussion