Overview
This node provides a generic interface to interact with any SuiteCRM module via the SuiteCRM API. Specifically, the "Get Relationships" operation retrieves related records for a given record in a specified module. This is useful when you want to fetch associated data such as linked contacts, opportunities, or custom relationships defined in SuiteCRM.
Common scenarios include:
- Fetching all related contacts for an account.
- Retrieving linked cases or activities for a specific lead.
- Accessing custom relationship data between modules for reporting or automation.
Example: Given an Account record ID, use this node to get all related Contacts connected to that Account.
Properties
| Name | Meaning |
|---|---|
| Module | Select the SuiteCRM module to operate on (e.g., Accounts, Contacts, Leads). |
| Record ID | The unique identifier of the record within the selected module whose relationships to retrieve. |
| Relationship | The type of relationship to fetch from the record. Options depend on the selected module and record ID (e.g., Contacts, Opportunities). |
Output
The output is an array containing one item with a json property. This json object holds the data returned by the SuiteCRM API for the requested relationship. It typically includes an array of related records with their attributes and metadata.
If the API response contains a data field, it is used directly; otherwise, the entire response is returned. No binary data output is produced by this operation.
Dependencies
- Requires valid SuiteCRM API credentials (an API key or token) configured in n8n.
- Needs network access to the SuiteCRM instance's API endpoint.
- Uses SuiteCRM REST API v8 endpoints.
Troubleshooting
- Invalid Credentials: If authentication fails, verify the API credentials and ensure they have sufficient permissions.
- Record Not Found: If the provided Record ID does not exist in the selected module, the API may return an error or empty data.
- Relationship Not Available: Selecting a relationship that does not exist for the given module or record will result in an error or empty response.
- API Endpoint Issues: Network errors or incorrect API URL configuration can cause request failures.
- To resolve errors, check the node parameters, confirm the SuiteCRM API URL, and validate the credentials.