Overview
This node integrates with the SuiteCRM API to perform various operations on CRM modules, such as retrieving records, creating, updating, deleting, and managing relationships. The 'Get' operation specifically fetches a list of records from a specified module, supporting filtering conditions and pagination. It is useful for workflows that need to query CRM data dynamically, for example, fetching customer records based on specific criteria or retrieving a limited set of leads for processing.
Use Case Examples
- Fetch up to 100 contacts from the Contacts module where the status is 'Active'.
- Retrieve accounts with a filter logic of 'OR' to combine multiple conditions.
- Query a custom module by specifying its path and applying filters on its fields.
Properties
| Name | Meaning |
|---|---|
| Module | The SuiteCRM module on which to perform the operation, e.g., Contacts, Accounts, or a Custom module. |
| Custom Module Path | Direct path to a custom module, used when the 'Custom' module option is selected. |
| Description | A description for the node instance, useful for documentation or identification. |
| Limit | The maximum number of records to fetch in the 'Get' operation, with a default of 100. |
| Logic | The logical operator ('AND' or 'OR') to combine multiple filter conditions in the query. |
| Fields | A collection of field filters to apply when querying records, including field name, operator (e.g., equal, greater than), and value. This is used for standard modules. |
| Custom Fields | Similar to 'Fields' but used for custom modules, allowing string field names and additional operators like 'starts with' and 'ends with'. |
Output
JSON
data- Array of records retrieved from the SuiteCRM module, each record containing the module's fields and values.
Dependencies
- SuiteCRM API
Troubleshooting
- Common issues include incorrect module names or paths, invalid filter field names or operators, and exceeding the limit parameter.
- Error messages may indicate authentication failures if the API key or credentials are incorrect.
- Network or API endpoint errors can occur if the SuiteCRM instance is unreachable or misconfigured.
Links
- SuiteCRM API Documentation - Official documentation for SuiteCRM API endpoints and usage.