CiviCRM

Interact with CiviCRM API v4 (Civi-Go compatible). Supports Contact, Membership, Group, Relationship and Activity entities. Includes dynamic mapping of email, phone, address and location types. Includes birth_date validation and JSON filters for GET MANY.
Join our community

Actions30

Overview

This node interacts with the CiviCRM API v4 to retrieve multiple Group records. It supports fetching many groups with optional filtering using JSON-based conditions. Users can choose to return all matching groups or limit the number of results. This operation is useful for scenarios where bulk data retrieval of groups is needed, such as syncing group data with other systems or generating reports.

Use Case Examples

  1. Retrieve all groups without limit to process or analyze them.
  2. Fetch a limited number of groups with specific criteria, e.g., groups with a certain name or attribute, by providing a JSON filter.

Properties

Name Meaning
Return All Determines whether to return all matching group records or limit the number of results.
Limit Specifies the maximum number of group records to return when 'Return All' is false. The value ranges from 1 to 1000.
Where (JSON) A JSON string representing filter conditions to apply when retrieving groups. For example, filtering groups by specific attributes.

Output

JSON

  • id - Unique identifier of the group.
  • name - Name of the group.
  • title - Title of the group.
  • subject - Subject or description of the group.
  • display_name - Display name of the group.

Dependencies

  • Requires an API key credential for authenticating with the CiviCRM API v4.

Troubleshooting

  • Invalid JSON in the 'Where (JSON)' property will cause an error. Ensure the JSON string is correctly formatted.
  • If the API request fails, check the API credentials and network connectivity.
  • If no groups are returned, verify the filter conditions and ensure groups exist matching those criteria.

Links

Discussion