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 contact records based on specified criteria. It supports filtering contacts by type (Individual, Organization, Household) and allows users to either return all matching contacts or limit the number of results. The node also supports advanced filtering using JSON-based conditions. This is useful for scenarios where bulk contact data retrieval is needed, such as syncing contacts with another system, generating reports, or performing batch updates.

Use Case Examples

  1. Retrieve all Individual contacts from CiviCRM.
  2. Fetch up to 100 Organization contacts with specific filtering criteria.
  3. Use JSON filters to get contacts matching complex conditions.

Properties

Name Meaning
Contact Type Specifies the type of contacts to retrieve (Individual, Organization, Household). Used to filter the contacts by their type.
Return All Boolean flag to determine whether to return all matching contacts or limit the number of results.
Limit Specifies the maximum number of contacts to return when 'Return All' is false. Value ranges from 1 to 1000.
Where (JSON) A JSON string representing filter conditions to apply when retrieving contacts. Allows advanced filtering based on contact fields.

Output

JSON

  • id - Unique identifier of the contact.
  • display_name - Display name of the contact.
  • first_name - First name of the contact.
  • last_name - Last name of the contact.
  • contact_type - Type of the contact (Individual, Organization, Household).
  • gender_id - Identifier for the contact's gender.
  • gender_id:name - Name of the contact's gender.
  • birth_date - Birth date of the contact.
  • emails - Array of email objects associated with the contact.
  • phones - Array of phone objects associated with the contact.
  • addresses - Array of address objects associated with the contact.

Dependencies

  • Requires an API key credential for CiviCRM API v4 authentication.

Troubleshooting

  • Invalid JSON in 'Where (JSON)' property will cause an error. Ensure the JSON string is correctly formatted.
  • If the 'birth_date' field is provided, it must be in a valid date format (YYYY-MM-DD). Incorrect formats will cause errors.
  • API request failures may occur due to incorrect credentials or network issues. Verify API token and endpoint URL.

Links

Discussion