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 various CiviCRM entities such as Contact, Membership, Group, Relationship, and Activity. Specifically, the 'Get Many' operation retrieves multiple records from the selected resource, supporting filtering via JSON-based 'where' conditions, and options to limit the number of results or return all matching records. It is useful for scenarios where bulk data retrieval is needed, such as fetching all contacts of a certain type or all memberships matching specific criteria.

Use Case Examples

  1. Retrieve all contacts with a specific contact type and filter conditions.
  2. Fetch a limited number of membership records based on custom JSON filters.

Properties

Name Meaning
Return All Determines whether to return all matching records or limit the number of results.
Limit Specifies the maximum number of records to return when 'Return All' is false. The value must be between 1 and 1000.
Where (JSON) A JSON string representing filter conditions to apply when retrieving records. For example, filtering contacts where first_name equals 'Alice'.

Output

JSON

  • json
    • id - The unique identifier of the retrieved record.
    • display_name - The display name of the record, if applicable.
    • first_name - The first name of the contact (for contact resource).
    • last_name - The last name of the contact (for contact resource).
    • contact_type - The type of contact, e.g., Individual, Organization, Household.
    • gender_id - The gender identifier of the contact.
    • gender_id:name - The name corresponding to the gender identifier.
    • birth_date - The birth date of the contact.
    • emails - An array of email records associated with the contact.
    • phones - An array of phone records associated with the contact.
    • addresses - An array of address records associated with the contact.

Dependencies

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

Troubleshooting

  • Invalid JSON in the 'Where (JSON)' property will cause an error; ensure the JSON is correctly formatted.
  • Invalid date formats in birth_date fields will throw errors; dates must be in ISO format (YYYY-MM-DD) or convertible to it.
  • API request failures may occur if the API credentials are incorrect or the CiviCRM server is unreachable.

Links

Discussion