EspoCRM icon

EspoCRM

Interact with EspoCRM API

Actions25

Overview

The "Get Many" operation for the "Custom Entity" resource in this EspoCRM node allows users to retrieve multiple records of a specified custom entity type from an EspoCRM instance. This operation is useful when you want to fetch lists of records such as Opportunities, Cases, Products, or any other custom entities defined in your CRM.

Common scenarios include:

  • Extracting a list of all open cases or opportunities for reporting.
  • Fetching a subset of products based on specific filters.
  • Paginating through large datasets of custom entities.
  • Retrieving only selected fields to optimize data transfer and processing.

For example, you might use this node to get all "Opportunity" records created in the last month, sorted by creation date, returning only their IDs and names.

Properties

Name Meaning
Entity Type Name or ID The type of custom entity to interact with (e.g., Opportunity, Case, Product). You can select from a dynamically loaded list or specify an ID using an expression.
Return All Boolean flag indicating whether to return all matching results or limit the number of returned records.
Limit Maximum number of results to return if "Return All" is false. Minimum value is 1. Default is 50.
Filter Options A collection of optional filters and query modifiers:
- Boolean Filter List Comma-separated list of predefined boolean filters (e.g., "onlyMy", "followed") to apply.
- Offset Number of results to skip, used for pagination. Defaults to 0.
- Order By Field name to sort the results by (e.g., "createdAt").
- Order Direction Sort direction: "Ascending" or "Descending". Default is "Ascending".
- Primary Filter Context-specific base filter to apply; depends on the CRM configuration.
- Select Fields Comma-separated list of fields to return for each record (e.g., "id,name"). If empty, all fields are returned.
- Where (Filter Conditions) JSON array defining filter conditions according to EspoCRM API syntax, allowing complex queries.
- Skip Total Count Boolean flag to skip calculating the total count of matching records, which can improve performance on large datasets. Default is false.

Output

The output is a JSON array where each element represents a single record of the requested custom entity type. Each record contains fields as specified by the "Select Fields" property or all fields if none are specified.

Example structure of one record in the output JSON:

{
  "id": "record_id",
  "name": "Record Name",
  "createdAt": "2023-01-01T12:00:00Z",
  "...": "other fields depending on selection"
}

If binary data were involved (not applicable here), it would be summarized accordingly, but this operation returns only JSON data representing entity records.

Dependencies

  • Requires connection to an EspoCRM instance via an API key or authentication token configured in n8n credentials.
  • Uses EspoCRM REST API endpoints to fetch data.
  • Relies on dynamic loading of entity types and field metadata from the EspoCRM Metadata Service.
  • No additional external services beyond EspoCRM API are required.

Troubleshooting

  • Error Loading Entity Types or Fields: If the node fails to load entity types or fields, ensure that the API credentials are correct and have sufficient permissions. Network connectivity to the EspoCRM server must be verified.
  • Invalid Filter Conditions: The "Where" filter expects valid JSON and must conform to EspoCRM API filter syntax. Malformed JSON or unsupported filters will cause errors.
  • Limit and Pagination Issues: Setting "Return All" to false with a very high limit may result in partial data. Use "Offset" and "Limit" properly to paginate through large datasets.
  • Permission Denied Errors: Ensure the API user has access rights to the specified custom entity and fields.
  • Timeouts or Performance Issues: For large datasets, enable "Skip Total Count" to improve performance by avoiding expensive count queries.

Links and References

Discussion