Overview
This node integrates with the Vtiger CRM API, enabling users to perform various operations on their Vtiger CRM data. The "Query" operation allows executing SQL-like queries against the CRM database to retrieve records matching specific criteria. This is useful for filtering leads, contacts, or other entities based on custom conditions.
Practical examples include:
- Retrieving all leads with email addresses from a particular domain.
- Fetching contacts created within a certain date range.
- Extracting opportunities with a specific status.
The node handles authentication by obtaining a challenge token and logging in with an API key credential before performing the requested operation.
Properties
| Name | Meaning |
|---|---|
| Query | SQL-supported query string to fetch data from Vtiger CRM. Example: SELECT * FROM Leads WHERE email LIKE '%@domain.com'; |
Output
The output is a JSON array containing the response from the Vtiger API for the executed query. It typically includes the queried records with their fields and values as returned by the CRM system.
If the query is successful, the JSON structure will have a success flag and a result array with the matched records.
No binary data output is produced by the "Query" operation.
Dependencies
- Requires connection to a Vtiger CRM instance via its webservice API endpoint.
- Needs an API key credential (username and access key) configured in n8n for authentication.
- Uses HTTP requests to communicate with the Vtiger API.
- No additional external libraries beyond those bundled with n8n are required.
Troubleshooting
- Authentication errors: If login fails, verify that the API credentials (username and access key) are correct and that the Vtiger host URL is reachable.
- Query syntax errors: Ensure the SQL query syntax matches what Vtiger supports; invalid queries will result in API errors.
- Empty results: Confirm that the query conditions match existing data; no matches will return empty arrays.
- API limits or timeouts: Large or complex queries might time out or be limited by the server; try simplifying queries or paginating results if supported.
Common error messages include:
"Invalid login"or"Access denied"indicating credential issues."Syntax error in query"pointing to malformed SQL.- Network-related errors if the Vtiger host is unreachable.