CiviCRM icon

CiviCRM

Interact with CiviCRM API v4 to manage contacts, memberships, groups, and more.

Custom API Call → Dynamic Search

AI-generated

Summary

Searches any CiviCRM APIv4 entity with {Entity}/get, returning the selected fields for matching records as individual n8n items. Configure the entity and JSON field selection, optionally add Where filters, and choose a result limit or return all records; verify field names with List Fields first.

Inputs

  • Entity (required) — CiviCRM APIv4 entity to search, such as Contact, Membership, or a custom entity.
  • Select (JSON) — JSON array of field names to return; defaults to ["id"]. Check available field names with List Fields.
  • Where (JSON) — Optional JSON array of [field, operator, value] filter triples, for example [["city","=","Bilbao"]].
  • Return All — Defaults to false. When enabled, retrieves results in pages of 500 until fewer than 500 are returned.
  • Limit — Maximum results when Return All is false; defaults to 100. The UI allows values from 1 to 1000.
  • Runtime Bearer Token (Optional) — Optional per-item JWT, often supplied by an expression. When provided, it is used for the request without retrying with the credential if the response is empty or errors. When omitted, the node uses its credential authentication behavior.
  • Base URL Override — Optional per-item CiviCRM site root replacing the credential Base URL. If no scheme is supplied, https:// is assumed; only HTTP and HTTPS URLs are accepted.

Output shape

A list of n8n items, one per returned record; each item's JSON contains the selected fields.

An empty result produces no record items. Invalid Select or Where JSON raises an error; with Continue On Fail enabled, the item instead contains an error message.

Links

Discussion