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.

Overview

This node interacts with the CiviCRM API v4 to retrieve multiple Activity records. It supports fetching many activities with optional filtering using JSON-based conditions. Users can specify whether to return all matching records or limit the number of results. This operation is useful for scenarios where bulk retrieval of activity data is needed, such as generating reports, syncing data, or analyzing user interactions within CiviCRM.

Use Case Examples

  1. Retrieve all activities related to a specific contact or group.
  2. Fetch a limited number of recent activities for dashboard display.
  3. Filter activities based on custom criteria using JSON conditions.

Properties

Name Meaning
Return All Determines whether to return all matching activity records or limit the number of results.
Limit Specifies the maximum number of activity records to return when 'Return All' is false. The value must be between 1 and 1000.
Where (JSON) A JSON string representing filter conditions to apply when retrieving activities. For example, filtering activities by specific fields or values.

Output

JSON

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

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.
  • Limit values outside the allowed range (1-1000) will cause validation errors.

Discussion