EspoCRM icon

EspoCRM

Interact with EspoCRM API

Actions25

Overview

This node integrates with the EspoCRM API to perform various operations on CRM data entities. Specifically, for the Custom Entity - Get operation, it retrieves a single record of a specified custom entity type by its record ID. This is useful when you need to fetch detailed information about a particular record in a custom entity, such as an Opportunity, Case, or Product, within EspoCRM.

Common scenarios include:

  • Fetching details of a specific customer case or support ticket.
  • Retrieving product information stored as a custom entity.
  • Accessing opportunity records for sales tracking.

Example: You want to get the details of a custom entity record representing a sales opportunity with a known ID to display or process it further in your workflow.

Properties

Name Meaning
Entity Type Name or ID The type of custom entity to interact with (e.g., Opportunity, Case, Product). Choose from a list or specify an ID using an expression.
Record ID The unique identifier of the record to retrieve within the specified custom entity type.

Output

The output is a JSON array where each element corresponds to the retrieved record(s). For the Get operation on a Custom Entity, the output will be a single JSON object representing the requested record's fields and values as returned by the EspoCRM API.

Example output structure:

{
  "id": "record-id",
  "name": "Record Name",
  "field1": "value1",
  "field2": "value2",
  ...
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to EspoCRM via an API key credential configured in n8n.
  • The node depends on EspoCRM's REST API being accessible and properly authenticated.
  • The entityType options are dynamically loaded from EspoCRM metadata, so the node requires network access to fetch these options.

Troubleshooting

  • Error loading entity types: If the dropdown for entity types fails to load, check network connectivity and API credentials.
  • Record not found: If the specified Record ID does not exist, the node may throw an error indicating the record was not found.
  • Invalid entity type or ID: Ensure the entity type name or ID is correct and exists in EspoCRM.
  • API authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Operation not supported: If an unsupported operation is selected, the node throws an error specifying the unsupported operation.

To resolve errors:

  • Confirm API credentials and permissions.
  • Validate input parameters, especially entityType and id.
  • Check EspoCRM API availability and response status.

Links and References

Discussion