n8n-nodes-sugarcrm

An n8n community node for interacting with the SugarCRM REST API (v11_11).

n8n is a fair-code licensed workflow automation platform.

Installation | Credentials | Resources | Operations | Usage | Compatibility

Installation

Follow the n8n community nodes installation guide.

In your n8n instance:

1. Go to Settings > Community Nodes
2. Select Install
3. Enter n8n-nodes-sugarcrm
4. Agree to the risks and select Install

Or install via the CLI:

npm install n8n-nodes-sugarcrm

Credentials

To connect to SugarCRM, you need to create credentials with the following fields:

| Field | Description | | --------------- | -------------------------------------------------------- | | Base URL | Your SugarCRM instance URL (e.g. https://yourinstance.sugarcrm.com) | | Username | SugarCRM username | | Password | SugarCRM password | | Client ID | OAuth2 client ID | | Client Secret | OAuth2 client secret |

Authentication uses the SugarCRM OAuth2 password grant flow.

Resources

The node supports the following SugarCRM modules:

• Account (Accounts)
• Contact (Contacts)
• Meter (M_Meters)
• Opportunity (Opportunities)
• Purchase Line Item (PurchasedLineItems)
• Report (Reports)
• Revenue Line Item (RevenueLineItems)
• Website Registration (WR_Website_Registrations)
• Other — specify any custom module endpoint

Operations

Each resource supports the following operations:

| Operation | Description | | ------------ | ------------------------ | | Create | Create a new record | | Delete | Delete a record by ID | | Get | Retrieve a record by ID | | Get Many | Retrieve multiple records | | Update | Update a record by ID |

Usage

Standard modules

Select a resource (e.g. Account, Contact) and an operation, then fill in the relevant fields:

• Get / Delete / Update require a record ID.
• Create / Update support Additional Fields (Name, Description) and a Custom JSON Payload for arbitrary field data.
• Get / Get Many support Query Parameters (key-value pairs or raw JSON).
• Get Many supports Return All to paginate through all results, or a Limit to cap the number of records.
• Create / Update / Get Many support a JSON Body for sending structured request data.

Reports

Select Report as the resource and Get as the operation. In the ID field, append the output format to the report ID:

{report-id}/JSON

Replace {report-id} with the actual SugarCRM report ID. Use /CSV if you need CSV output instead.

Other (custom modules)

Select Other as the resource to call any SugarCRM module endpoint not listed above. Enter the module name in the Custom Endpoint field (e.g. Calls, Tasks, CustomModule_c). All standard operations and fields are available.

Compatibility

Tested against the SugarCRM REST API v11_11. Compatible with n8n version 0.x and 1.x.

License

MIT