CiviCRMInstall

Summary

Retrieve multiple CiviCRM contacts, optionally filtering by contact type and JSON conditions. Return each contact as a separate n8n item, including selected contact fields and linked emails, phones, and addresses.

Inputs

• Contact Type — Choose Any (the default) to include all contact types, or filter to Individual, Organization, or Household.
• Runtime Bearer Token (Optional) — Optional JWT supplied directly or by expression. When set, it is used for the request without retrying with credential-based authentication if the response is empty or an error. Leave empty to use the configured CiviCRM credential, including its JWT auto-resolve or API key behavior.
• Base URL Override — Optional CiviCRM site root for this item, without /civicrm. Supports expressions; a missing URL scheme defaults to HTTPS, and only HTTP or HTTPS is accepted.
• Return All — When enabled, fetch contacts in pages of 500 until fewer than 500 are returned. When disabled, return up to the Limit.
• Limit — Maximum contacts to return when Return All is disabled. Defaults to 100; the UI allows values from 1 to 1000.
• Where (JSON) — Optional JSON array of filter triples, such as [["first_name","=","Alice"]]. A selected Contact Type filter is added to these conditions.

Output shape

A list of n8n items, one per contact returned.

Each contact includes the selected fields id, display_name, first_name, last_name, organization_name, legal_name, contact_type, gender_id, gender_id:name, and birth_date, plus chained email, phone, and address results. With no matches, the operation adds no contact items. If Continue On Fail is enabled, an item error is returned for a failed input item.

Examples

Example 1: Find Alice's individual contacts

Set Contact Type to Individual and Where (JSON) to [["first_name","=","Alice"]]; set a Limit or enable Return All.

Links

• n8n community nodes installation guide