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 Contact resources. Specifically, the 'Get' operation retrieves detailed information about a single contact by its ID. It fetches core contact details such as ID, display name, first and last names, contact type, gender, and birth date. Additionally, it retrieves related chained data including the contact's emails, phone numbers, and addresses. This node is useful in scenarios where you need to fetch comprehensive contact information from a CiviCRM system, for example, to display contact details in a CRM dashboard or to use contact data in further workflow automation.

Use Case Examples

  1. Retrieve a contact's full profile by specifying their unique ID to display or process their information in another system.
  2. Fetch contact details including emails, phones, and addresses for customer support or marketing automation.

Properties

Name Meaning
Contact Type Specifies the type of contact to operate on, such as Individual, Organization, or Household.
ID The unique identifier of the contact to retrieve. This is required for the Get operation.

Output

JSON

  • id - Unique identifier of the contact.
  • display_name - The display name of the contact.
  • first_name - The first name of the contact.
  • last_name - The last name of the contact.
  • contact_type - The type of contact (Individual, Organization, Household).
  • gender_id - The gender identifier of the contact.
  • gender_id:name - The name of the gender associated with the contact.
  • birth_date - The birth date of the contact.
  • emails - An array of email objects associated with the contact.
  • phones - An array of phone objects associated with the contact.
  • addresses - An array of address objects associated with the contact.

Dependencies

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

Troubleshooting

  • Ensure the provided contact ID exists in the CiviCRM system; otherwise, the node will return an empty result or error.
  • Verify that the API credentials are correctly configured and have sufficient permissions to access contact data.
  • If the birth_date field is provided or processed, ensure it is in a valid date format (YYYY-MM-DD) to avoid validation errors.

Links

Discussion