civicrm

Full-featured CiviCRM API v4 integration for n8n with support for Contacts, Memberships, Groups, Relationships, Activities and structured sub-entities like Email, Phone, and Address.

Package Information

Downloads: 95 weekly / 280 monthly
Latest Version: 1.0.14
Author: Julian Reartes

Available Nodes

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.

Documentation

n8n-nodes-civicrm

n8n Community Node
CiviCRM API v4
TypeScript

Community Node for CiviCRM API v4 (Civi-Go compatible)
Developed and maintained by Ixiam Global Solutions.

This package provides integration between n8n and CiviCRM API v4, supporting create, update, delete operations, advanced filtering, dynamic location types, and structured sub-entities (email, phone, address).
Custom fields are not supported.

Installation

  1. In your n8n instance, open:
    Settings → Community Nodes → Install
  2. Enter the package name:
@ixiam/n8n-nodes-civicrm
  1. Confirm installation and enable Community Nodes.
  2. If running n8n via Docker, restart/rebuild for the node to load.

Credentials

Authentication uses Bearer Token.

Field Description
Base URL Root URL of your CiviCRM instance (no trailing slash). Example: https://crm.example.org
API Token Sent as header X-Civi-Auth: Bearer <token>

Supported Entities

This node implements API v4 operations for:

  • Contact
  • Membership
  • Group
  • Relationship
  • Activity
  • Custom API Call (raw API4 request)

Each entity supports:

  • get
  • getMany
  • create
  • update
  • delete

Features

Email, phone and address with location types

Two mapping modes:

Simple:

email = test@example.org
address.city = Barcelona

With location prefixes:

work.email = user@company.org
billing.address.postal_code = 08014
home.phone.phone_type_id = 2

GET MANY with JSON filters

Example:

[
  ["first_name", "LIKE", "Ju%"],
  ["birth_date", ">", "1990-01-01"],
  ["gender_id", "IN", [1, 2]]
]

Birth date normalization

Accepted input formats:

  • YYYY-MM-DD
  • DD/MM/YYYY
  • DD-MM-YYYY
  • YYYY/MM/DD
  • YYYY.MM.DD

Normalized to YYYY-MM-DD.

Custom API Call

Example:

{
  "entity": "Contact",
  "action": "get",
  "params": { "limit": 10 }
}

Compatibility

  • n8n version: 1.0.0 or higher
  • Node.js: 18 or higher
  • CiviCRM: API v4 compatible (including Civi-Go)

Development

Clone the repository and run:

npm install
npm run dev

Build:

npm run build

Contributions

Pull requests and issues are welcome in the GitHub repository.

About Ixiam Global Solutions

Website: https://www.ixiam.com
Email: info@ixiam.com

License

MIT License

Discussion