Overview

This node interacts with the CiviCRM API v4 to perform operations on various CiviCRM entities such as Contact, Membership, Group, Relationship, and Activity. Specifically, for the 'Custom API Call' resource with the 'Get' operation, it retrieves a single record by its ID. This is useful for fetching detailed information about a specific entity, for example, retrieving a contact's details including emails, phones, and addresses.

Use Case Examples

1. Fetch a contact's details by providing the contact ID to get their name, contact type, gender, birth date, and associated emails, phones, and addresses.
2. Retrieve a membership record by its ID to view membership details.

Properties

Output

JSON

• id - The unique identifier of the retrieved record.
• display_name - The display name of the contact or entity.
• first_name - First name of the contact (if applicable).
• last_name - Last name of the contact (if applicable).
• contact_type - Type of contact such as Individual, Organization, or Household.
• gender_id - Gender identifier of the contact.
• gender_id:name - Name of the gender associated with the contact.
• birth_date - Birth date of the contact.
• emails - Array of email records associated with the contact.
• phones - Array of phone records associated with the contact.
• addresses - Array of address records associated with the contact.

Dependencies

• Requires an API key credential for CiviCRM API authentication.

Troubleshooting

• Ensure the provided ID exists in the CiviCRM database; otherwise, the node will return an empty result.
• Invalid birth_date format errors may occur if date strings are not in recognized formats (YYYY-MM-DD, MM/DD/YYYY, etc.).
• API authentication errors if the API token or base URL credentials are incorrect or missing.

Links

• CiviCRM API v4 Documentation - Official documentation for the CiviCRM API v4 used by this node.