n8n-nodes-suitecrm

n8n node to interact with SuiteCRM via REST API v8.

Installation

Option 1: Install from npm

npm install n8n-nodes-suitecrm

Option 2: Install locally for development

cd /path/to/n8n-nodes-suitecrm
npm install
npm run build

Then link the package to your n8n installation:

cd ~/.nvm/versions/node/vX.X.X/lib/node_modules
npm link /path/to/n8n-nodes-suitecrm

Or copy the dist folder to your n8n custom nodes directory:

• ~/.nvm/versions/node/vX.X.X/lib/node_modules/n8n/nodes/ (global)
• ./data/nodes/ (when using n8n start with custom directory)

Configuration

1. Create OAuth2 Client in SuiteCRM

1. Log into your SuiteCRM instance as admin
2. Go to Admin > OAuth Clients
3. Create a new OAuth2 client:
   • Name: n8n Integration
   • Client ID: n8n_client
   • Client Secret: Copy the generated secret
   • Grant Type: Password

2. Configure n8n Credentials

1. In n8n, go to Credentials and add a new SuiteCRM API credential
2. Enter:
   • API URL: Your SuiteCRM base URL (e.g., https://your-suitecrm.com)
   • Client ID: From the OAuth client you created
   • Client Secret: From the OAuth client you created
   • Username: SuiteCRM user username
   • Password: SuiteCRM user password

Node Operations

List Records

• Select module (Accounts, Contacts, Leads, etc.)
• Set limit (1-100, default 20)
• Returns paginated list of records

Get Record

• Select module
• Enter Record ID
• Returns single record by ID

Create Record

• Select module
• Enter Name/Title
• Optionally add JSON attributes (e.g., {"phone": "+123456789", "email": "test@example.com"})

Update Record

• Select module
• Enter Record ID
• Enter Name/Title
• Optionally add JSON attributes

Delete Record

• Select module
• Enter Record ID
• Deletes the specified record

Search Records

• Select module
• Enter JSON filter (e.g., {"filter": {"conditions": [{"field": "name", "operator": "equals", "value": "Test"}]}})

API Endpoints Used

Method	Endpoint	Description
POST	/Api/access_token	OAuth2 token authentication
GET	/Api/V8/module/{module}	List records
GET	/Api/V8/module/{module}/{id}	Get single record
POST	/Api/V8/module/{module}	Create record
PATCH	/Api/V8/module/{module}/{id}	Update record
DELETE	/Api/V8/module/{module}/{id}	Delete record
POST	/Api/V8/module/{module}/filter	Search records

Development

# Build TypeScript
npm run build

# Lint code
npm run lint

# Run tests
npm test

Supported Modules

• Accounts
• Contacts
• Leads
• Opportunities
• Cases
• Notes
• Tasks

License

<<<<<<< HEAD
MITci-test-push-1777408324

MITtest
test2

origin/ci-test