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 perform operations on the Relationship resource. Specifically, the 'Get' operation retrieves detailed information about a specific Relationship entity by its ID. This is useful for scenarios where you need to fetch relationship data between contacts or entities managed in CiviCRM, such as organizational relationships or personal connections.

Use Case Examples

  1. Retrieve a relationship record by its unique ID to display or process relationship details in a workflow.
  2. Fetch relationship data to synchronize with another system or to trigger further automation based on relationship attributes.

Properties

Name Meaning
ID The unique identifier of the Relationship entity to retrieve. This property is required for the 'Get' operation.

Output

JSON

  • json
    • id - The unique identifier of the Relationship entity.
    • name - The name of the Relationship.
    • title - The title associated with the Relationship.
    • subject - The subject or description of the Relationship.
    • display_name - A display-friendly name for the Relationship.

Dependencies

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

Troubleshooting

  • Ensure the provided ID exists in the CiviCRM system; otherwise, the node may return an empty result or error.
  • Verify that the API credentials are correctly configured and have sufficient permissions to access Relationship data.
  • Check network connectivity and API endpoint URL correctness if requests fail.

Links

  • CiviCRM API v4 Documentation - Official documentation for the CiviCRM API v4, detailing available resources and operations including Relationship.

Discussion