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 Relationship records based on specified criteria. It supports filtering with JSON-based conditions and allows users to either return all matching records or limit the number of results. This is useful for scenarios where bulk retrieval of relationship data is needed, such as generating reports, syncing data with other systems, or performing batch operations on relationships.

Use Case Examples

  1. Retrieve all relationships without limit.
  2. Retrieve up to 100 relationships matching specific criteria, e.g., relationships involving a certain contact.

Properties

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

Output

JSON

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

Dependencies

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

Troubleshooting

  • Invalid JSON in 'Where (JSON)' property will cause an error; ensure the JSON string is correctly formatted.
  • API request failures may occur due to incorrect credentials or network issues; verify API key and connectivity.
  • If no records are returned, check the filter conditions in 'Where (JSON)' to ensure they match existing data.

Links

Discussion