Apaleo icon

Apaleo

Interact with Apaleo API

Actions66

Group → GET count groups

AI-generated

Overview

This node operation interacts with the Apaleo API to retrieve the count of groups based on specified filters. It is useful for scenarios where you need to know the number of groups that match certain criteria, such as searching by text, filtering by property IDs, or filtering by date ranges. For example, it can be used to get the count of customer groups created within a specific timeframe or matching a particular search term.

Use Case Examples

  1. Count groups with a name or company matching a search text.
  2. Count groups associated with specific property IDs.
  3. Count groups created between two dates.

Properties

Name Meaning
Text Search Search text to filter groups by name, lastname, firstname, email, or company name.
Property IDs Filter groups by property IDs.
From Start date for filtering groups.
To End date for filtering groups.

Output

JSON

  • count - The total number of groups matching the specified filters.

Dependencies

  • Requires an API key credential for Apaleo API authentication.

Troubleshooting

  • Common issues include invalid or expired API credentials, resulting in authentication errors.
  • Incorrect date formats or invalid filter values may cause the API to return errors or no results.
  • If the node throws errors, ensure the 'resource' is set to 'Group' and 'operation' to 'GET count groups' with valid parameters.

Links

  • Apaleo API Reference - Official API documentation for Apaleo, useful for understanding available endpoints and parameters.

Discussion