CiviCRMInstall

Summary

Retrieves CiviCRM groups through the API v4 Group/get endpoint, optionally filtering results and returning one or all matching records. Each returned group is emitted as a separate n8n item.

Inputs

• Runtime Bearer Token (Optional) — Optional JWT supplied directly or by expression. When set, the request uses it as the bearer token and does not retry with the credential if the response is empty or errors.
• Base URL Override — Optional CiviCRM site root for this item, without /civicrm. Use it to target a different instance; a missing scheme is treated as https://, and only HTTP or HTTPS URLs are accepted.
• Return All — When enabled, fetches results in pages of 500 until no more are returned. Defaults to false.
• Limit — Maximum number of groups to fetch when Return All is off. Defaults to 100; the UI accepts values from 1 to 1000.
• Where (JSON) — Optional JSON array of CiviCRM filter conditions, such as [["title","=","Members"]]. Defaults to no filters.

Output shape

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

The request selects id, name, title, subject, and display_name. With Return All disabled, the result is capped by Limit; with it enabled, the node pages through results. If no groups match, no group items are emitted. Invalid Where JSON or API errors fail the item unless continueOnFail is enabled.

Links

• n8n community nodes installation guide