Overview
This node integrates with the Vtiger CRM API, enabling users to perform various operations on Vtiger entities. Specifically, the "Retrieve Related" operation fetches related records of a given entity within Vtiger CRM. This is useful when you want to obtain associated data, such as contacts related to an account or activities linked to a project.
Practical examples include:
- Retrieving all contacts related to a specific company.
- Fetching all tasks or events linked to a particular lead.
- Accessing related modules' data for reporting or automation workflows.
Properties
| Name | Meaning |
|---|---|
| Entity ID | The unique identifier of the main entity in Vtiger, formatted as MODULExID (e.g., "1x1234"). |
| Module | The exact module name (case sensitive) of the related records you want to retrieve. |
| Module Label | The exact label name (case sensitive) of the related module defining the relationship type. |
Output
The output is a JSON array containing the response from the Vtiger API for the "retrieve_related" operation. This typically includes the list of related records and their details associated with the specified entity.
If the node supports binary data output (not applicable for this operation), it would represent files or attachments; however, "Retrieve Related" only returns JSON data about related entities.
Dependencies
- Requires connection to a Vtiger CRM instance via its webservice API.
- Needs an API authentication token (access key) and username configured in n8n credentials.
- The node performs HTTP requests to the Vtiger API endpoints.
- No additional external dependencies beyond standard HTTP and form-data handling.
Troubleshooting
- Authentication errors: If the node fails at the login step, verify that the API credentials (username and access key) are correct and that the Vtiger host URL is reachable.
- Entity not found: If the specified Entity ID does not exist, the API will return an error. Double-check the format and correctness of the Entity ID.
- Incorrect module or label names: The "Module" and "Module Label" fields are case sensitive. Using incorrect values will result in empty or error responses.
- Network issues: Ensure that the Vtiger server is accessible from the n8n environment.
- API limits or permissions: Make sure the user associated with the API key has sufficient permissions to retrieve related records.