Overview
This node provides a generic interface to interact with any SuiteCRM module via the SuiteCRM API. It supports multiple operations such as retrieving all records, fetching a single record, creating, updating, deleting records, and getting related records from relationships.
The Get All operation fetches multiple records from a selected SuiteCRM module, supporting pagination, filtering, and limits on the number of records returned. This is useful for scenarios where you want to extract bulk data from SuiteCRM modules like Contacts, Accounts, Leads, or custom modules for reporting, synchronization, or automation workflows.
Practical examples:
- Retrieve all contacts created in the last month with specific filters.
- Fetch a limited number of accounts for processing in another system.
- Auto-paginate through all leads to export them to a marketing platform.
Properties
| Name | Meaning |
|---|---|
| Module | Select the SuiteCRM module to operate on (e.g., Contacts, Accounts, Leads). The list is dynamically loaded from the SuiteCRM instance. |
| Options | Collection of optional parameters for the Get All operation: |
| Page Size | Number of records per page to retrieve (default 20, max 100). Controls pagination size. |
| Page Number | Page number to retrieve (starting at 1). Used for manual pagination. |
| Filters | One or more filters to apply when querying records. Each filter includes: Field (selectable or custom), Operator (equals, not equals, greater than, etc.), and Value. Filters narrow down the results based on field values. |
| Return All | Boolean flag to enable auto-pagination and fetch all matching records regardless of limit. |
| Limit | Maximum number of records to return if "Return All" is false. |
Output
The output is an array of items, each containing a json property representing a single SuiteCRM record retrieved from the selected module.
- Each item corresponds to one record.
- The structure of each record matches the SuiteCRM API response for that module, typically including fields and their values.
- No binary data is output by this operation.
Example output item:
{
"json": {
"id": "12345",
"name": "John Doe",
"email": "john.doe@example.com",
...
}
}
Dependencies
- Requires valid credentials for authenticating with the SuiteCRM API (an API key or OAuth token).
- Needs the SuiteCRM instance URL and access token to make authenticated requests.
- The node uses internal helper methods to authenticate and fetch data from SuiteCRM's REST API endpoints.
- Pagination and filtering depend on SuiteCRM API capabilities.
Troubleshooting
- Authentication errors: Ensure the provided API credentials are correct and have sufficient permissions to access the requested modules.
- Module not found: If the selected module does not exist or is misspelled, the API will fail. Verify the module name is correct and available in your SuiteCRM instance.
- Filter issues: Incorrect field names or unsupported operators in filters may cause errors or empty results. Use the dynamic field loader to select valid fields.
- Pagination limits: Setting very high page sizes or limits might lead to timeouts or performance issues depending on the SuiteCRM server.
- API rate limits: Excessive requests with "Return All" enabled could hit API rate limits; consider using limits or delays.