Overview

This node operation retrieves a list of groups from the Apaleo API. It supports filtering groups by text search (matching name, lastname, firstname, email, or company name), property IDs, and date range (from and to). It also supports pagination through page number and page size parameters, and allows expanding additional related data such as blocks or actions in the response. This operation is useful for scenarios where you need to fetch and manage group data from Apaleo, for example, to display group information in a dashboard or to process group-related workflows.

Use Case Examples

1. Fetch groups filtered by a specific company name using text search.
2. Retrieve groups created within a specific date range for reporting purposes.
3. Paginate through groups with a page size of 50 to handle large datasets efficiently.
4. Expand related blocks and actions data for each group to get detailed information in one request.

Properties

Output

JSON

• groups
  • ``
    * id - Unique identifier of the group.
    * name - Name of the group.
    * properties - Properties associated with the group.
    * blocks - Blocks data included if 'Blocks' is selected in the expand option.
    * actions - Actions data included if 'Actions' is selected in the expand option.

Dependencies

• Apaleo API access token credential

Troubleshooting

• Common issues include invalid or expired API access token, resulting in authentication errors. Ensure the API token is valid and refreshed as needed.
• Incorrect filter parameters (e.g., invalid date format or property IDs) may cause the API to return errors or empty results. Validate input parameters before execution.
• Pagination parameters must be positive integers; otherwise, the API may reject the request.

Links

• Apaleo API Groups Documentation - Official API documentation for managing groups in Apaleo.