Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions45

Overview

This node integrates with the Apaleo API to retrieve information about groups. Specifically, the "GET groups" operation fetches a list of groups filtered and paginated according to user-defined criteria. This is useful in scenarios where you want to manage or analyze group data related to bookings, such as retrieving guest groups, corporate clients, or other categorized entities within the Apaleo system.

Practical examples include:

  • Fetching all groups created within a specific date range.
  • Searching for groups by name, email, or company.
  • Paginating through large sets of group data to process or display in batches.
  • Expanding group data to include related blocks or actions for deeper insights.

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 created or modified from this point onwards.
To End date/time to filter groups created or modified up to this point.
Page Number Page number for pagination (minimum value: 1).
Page Size Number of items per page for pagination (minimum value: 1).
Expand Additional data to include in the response; options are "Blocks" and "Actions".

Output

The output is an array of JSON objects representing groups matching the specified filters and pagination settings. Each group object contains standard group details such as identifiers, names, contact information, and potentially expanded related data if requested via the "Expand" property:

  • If "Blocks" is expanded, the output includes associated block data relevant to each group.
  • If "Actions" is expanded, the output includes action-related data linked to each group.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the Apaleo API using a valid API authentication token.
  • The node expects the user to configure credentials providing access to the Apaleo API.
  • Network connectivity to https://api.apaleo.com is necessary.

Troubleshooting

  • Common issues:

    • Invalid or expired API token leading to authentication errors.
    • Incorrect date formats for "From" and "To" properties causing request failures.
    • Pagination parameters out of range or invalid (e.g., page number less than 1).
    • Filtering by property IDs that do not exist or are not accessible.

  • Error messages:

    • Authentication errors typically indicate problems with the API key or token; re-authenticate or update credentials.
    • Validation errors on input parameters suggest checking the format and allowed values, especially for dates and numbers.
    • Network errors may require verifying internet connectivity or API endpoint availability.

Links and References

Discussion