Overview
This node integrates with SinergiaCRM, a SuiteCRM API-compatible system, allowing users to perform various operations on any module within SinergiaCRM. The "Get All" operation fetches multiple records from a selected module, supporting pagination, filtering, and limits.
Common scenarios include:
- Retrieving all contacts, accounts, or custom module records for reporting or synchronization.
- Applying filters to extract specific subsets of data (e.g., all leads created after a certain date).
- Paginating through large datasets efficiently.
Practical example:
- Fetching all "Contacts" where the "status" field equals "Active", retrieving 50 records per page, and iterating through pages until all matching records are collected.
Properties
| Name | Meaning |
|---|---|
| Module | Selects the SinergiaCRM module to operate on (e.g., Contacts, Accounts, or any custom module). |
| Options | Collection of additional parameters for the "Get All" operation: - Page Size: Number of records per page (default 20, max 100). - Page Number: Which page to retrieve (starting at 1). - Filters: Multiple filters can be applied, each specifying: • Field (selectable or custom) • Operator (Equals, Not Equals, Greater Than, etc.) • Value to filter by. |
| Return All | Boolean flag to enable auto-pagination and fetch all records matching criteria, ignoring the limit. |
| Limit | Maximum number of records to return when "Return All" is disabled. |
Output
The output consists of an array of items, each containing a json property with one record's data from the selected module. Each record corresponds to a single entity in SinergiaCRM and includes all fields returned by the API.
No binary data is output by this node.
Example output item structure (simplified):
{
"json": {
"id": "record-id",
"field1": "value1",
"field2": "value2",
...
}
}
Dependencies
- Requires an API authentication credential for SinergiaCRM, including the domain URL and access token.
- The node uses the SinergiaCRM REST API v8 endpoints.
- No additional external dependencies beyond standard HTTP requests authenticated via the provided credentials.
Troubleshooting
Common issues:
- Incorrect module name or unavailable module: Ensure the selected module exists in SinergiaCRM.
- Invalid filter fields or operators: Filters must use valid field names and supported operators.
- Pagination errors: When using "Return All," ensure the API supports pagination and that page size limits are respected.
- Authentication failures: Verify that the API credentials are correct and have sufficient permissions.
Error messages:
- API request errors will typically include HTTP status codes and messages from SinergiaCRM. For example, 401 Unauthorized indicates invalid credentials.
- Filter-related errors may indicate unknown fields or unsupported operators.
Resolution tips:
- Double-check module and field names against SinergiaCRM configuration.
- Use smaller page sizes if timeouts or rate limits occur.
- Confirm API credentials and domain URL correctness.
- Enable "Continue On Fail" in the node settings to handle partial failures gracefully.
Links and References
- SinergiaCRM API Documentation (replace with actual URL)
- SuiteCRM API v8 Reference
- n8n Documentation on HTTP Request Node (for understanding underlying request mechanics)