SuiteCRM

Overview

This node provides a generic interface to interact with any module in a SuiteCRM instance via its API. It supports common operations such as retrieving a single record, fetching multiple records, creating, updating, deleting records, and getting related records (relationships). This flexibility makes it useful for automating CRM workflows, integrating SuiteCRM data into other systems, or building custom dashboards.

For the Get One operation specifically, the node fetches a single record from a specified SuiteCRM module by its unique record ID. This is beneficial when you need detailed information about a specific entity, such as a contact, account, or opportunity, identified by its ID.

Practical example:

• Retrieve details of a specific customer by their record ID to display on a dashboard.
• Fetch a particular sales opportunity's data before processing it in another workflow step.

Properties

Output

The output is an array containing one item with a json property. This json object holds the data of the requested record fetched from the SuiteCRM API.

• The structure of the json output corresponds directly to the SuiteCRM API response for the record.
• If the API returns a wrapped response, the node extracts the .data field; otherwise, it returns the full response.
• No binary data is output by this operation.

Example output structure (simplified):

{
  "id": "record-id",
  "type": "ModuleName",
  "attributes": {
    "field1": "value1",
    "field2": "value2",
    ...
  },
  "relationships": {
    ...
  }
}

Dependencies

• Requires valid credentials for authenticating with the SuiteCRM API (an API access token).
• The node uses the SuiteCRM REST API v8 endpoints.
• The SuiteCRM instance URL and authentication token are obtained via configured credentials.
• No additional external services are required beyond the SuiteCRM API.

Troubleshooting

• Invalid or missing record ID: Ensure the provided record ID exists in the selected module; otherwise, the API will return an error or empty response.
• Authentication errors: Verify that the API credentials are correct and have sufficient permissions to access the module and record.
• Module not found: The selected module must exist in the SuiteCRM instance; use the node’s module loading options to select valid modules.
• API endpoint errors: Network issues or incorrect SuiteCRM base URL configuration can cause request failures.
• Empty response: If the record does not exist or is inaccessible, the node may return an empty object or no data.

To resolve these issues:

• Double-check input parameters.
• Confirm API credentials and permissions.
• Test connectivity to the SuiteCRM API outside n8n if needed.

Links and References

• SuiteCRM REST API Documentation
• SuiteCRM Official Website
• n8n Documentation - Creating Custom Nodes