Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions57

Overview

This node interacts with the Apaleo API to retrieve information about groups. Specifically, the "GET count groups" operation counts the number of groups that match certain filter criteria such as text search, associated property IDs, and a date range. This is useful in scenarios where you want to quickly determine how many groups meet specific conditions without retrieving full group details.

Practical examples include:

  • Counting how many guest groups have been created or updated within a certain timeframe.
  • Filtering groups by properties they are associated with (e.g., specific hotels or locations).
  • Searching groups by text fields like name, email, or company name to get a quick count for reporting or monitoring purposes.

Properties

Name Meaning
Text Search Search text to filter groups by name, lastname, firstname, email, or company name.
Property IDs Filter groups by one or more property IDs (multiple values allowed).
From Start date/time to filter groups from (inclusive).
To End date/time to filter groups up to (inclusive).

Output

The output is an array of JSON objects representing the result of the count query. Typically, this will contain a single object with a field indicating the total count of groups matching the filters.

Example output structure (conceptual):

[
  {
    "count": 123
  }
]

No binary data output is involved in this operation.

Dependencies

  • Requires an API authentication token credential for the Apaleo API.
  • The node uses the base URL https://api.apaleo.com to make requests.
  • No additional external services beyond the Apaleo API are required.

Troubleshooting

  • Common issues:

    • Invalid or expired API token: Ensure the API key/credential used is valid and has not expired.
    • Incorrect date formats: The "From" and "To" properties expect valid ISO 8601 date-time strings.
    • Empty or invalid property IDs: Make sure property IDs are correctly specified if filtering by them.
    • Network connectivity issues: Verify network access to https://api.apaleo.com.

  • Error messages:

    • Authentication errors typically indicate problems with the API token; re-authenticate or update credentials.
    • Validation errors may occur if input parameters do not conform to expected formats; check property types and values.
    • API rate limits or server errors from Apaleo should be handled by retrying after some delay or contacting support.

Links and References

Discussion