Skip to main content
Espocrm logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 16
  • Triggers: 0
  • Slug: ESPOCRM
  • Version: 20261101_00

Tools

Slug: ESPOCRM_CREATE_RECORDCreate a record for any standard or custom EspoCRM entity type.

Input Parameters

object
required
Non-empty object of provider-native field names and JSON-safe values for the new record. Required fields depend on the selected entity type.
string
required
EspoCRM entity type to create, such as Account, Contact, or a custom entity type from Entity Manager.
boolean
Set true to bypass EspoCRM’s duplicate-record check for this creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ESPOCRM_DOWNLOAD_ATTACHMENTDownload an EspoCRM attachment by attachment record ID.

Input Parameters

string
required
Unique ID of the EspoCRM attachment record.
string
required
Safe output filename for the downloaded attachment, including its extension.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ESPOCRM_FOLLOW_RECORDFollow an EspoCRM record so its updates appear in the user’s stream.

Input Parameters

string
required
Unique ID of the EspoCRM record.
string
required
EspoCRM entity type of the record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ESPOCRM_GET_APP_USERTool to retrieve current user data including token, ACL, and preferences. Use after successful authentication to fetch session-specific profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ESPOCRM_GET_CURRENCY_RATESRetrieve the currency rates configured in EspoCRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ESPOCRM_GET_LABELSRetrieve all EspoCRM labels in the user or system default language.

Input Parameters

boolean
Set true to force labels to use the system default language.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ESPOCRM_GET_METADATARetrieve available EspoCRM application metadata or one metadata path. The returned metadata is JSON-encoded in string fields.

Input Parameters

string
Dot-separated metadata path to return, such as entityDefs.Lead.fields.status.options. Omit to return all available metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ESPOCRM_GET_RECORDRetrieve one standard or custom EspoCRM entity record by its ID.

Input Parameters

string
required
Unique ID of the record to retrieve.
string
required
EspoCRM entity type, including a tenant-defined custom entity type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ESPOCRM_LIST_RECORDSList one page of records for any standard or custom EspoCRM entity type.

Input Parameters

string ("asc" | "desc")
Sort direction: asc or desc.
array
Structured EspoCRM filters. Use either where or its firewall-safe alias whereGroup, not both.
integer
Zero-based record offset for this page.
string
Comma-separated attributes to return, without whitespace. Omit to return all attributes.
integer
Maximum number of records to return in this page.
boolean
Set true to omit the total count for a faster query on large tables.
string
Entity attribute to sort by.
string
required
Entity type to list, such as Account, Contact, or a custom entity type.
array
EspoCRM v9.0+ firewall-safe alias of where with identical filter semantics.
string
Entity-specific primary filter defined by the instance, such as open.
string
EspoCRM v9.0+ firewall-safe alias of select with identical comma-separated attribute semantics.
array
Entity-specific boolean filters, such as onlyMy or followed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ESPOCRM_LIST_RECORD_STREAMList one page of stream notes for a standard or custom EspoCRM record.

Input Parameters

integer
Zero-based stream note offset.
integer
Maximum number of stream notes to return.
string
required
Unique ID of the EspoCRM record.
string
required
EspoCRM entity type of the record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ESPOCRM_LIST_STREAMList one page of stream notes visible to the current EspoCRM user.

Input Parameters

integer
Zero-based stream note offset.
integer
Maximum number of stream notes to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ESPOCRM_POST_STREAM_NOTEPost a note to an EspoCRM record stream, optionally with attachments.

Input Parameters

string
required
Text to post to the record stream.
string
required
ID of the record to post to.
string
required
Entity type of the record to post to.
array
IDs of attachments that were uploaded separately beforehand.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ESPOCRM_RELATE_RECORDSRelate one or more existing records through a named EspoCRM link.

Input Parameters

Relationship link name from EspoCRM Entity Manager.
array
Required search criteria when mass_relate is true; omit for explicit IDs.
string
required
ID of the source record.
string
required
Entity type of the source record, such as Account or Contact.
boolean
Set true to relate every record matching where instead of explicit IDs.
ID of one existing record to relate. Use this or related_record_ids, not both.
Non-empty IDs of existing records to relate. Use this or related_record_id, not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ESPOCRM_UPDATE_RECORDPartially update any standard or custom EspoCRM entity record.

Input Parameters

object
required
Non-empty map of EspoCRM field names to provider-native JSON values. Only supplied fields are updated.
string
required
ID of the EspoCRM record to update.
string
required
EspoCRM entity type, such as Account or a custom entity name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ESPOCRM_UPLOAD_ATTACHMENTUpload a file for an EspoCRM File or Attachment-Multiple field.

Input Parameters

object
required
File to upload to EspoCRM.
string
required
Name of the File or Attachment-Multiple field that will hold the attachment.
Existing record ID containing the File field. Requires related_type.
string
Entity type containing an Attachment-Multiple field. Do not combine with related_type or related_id.
Entity type containing a File field. May be used without related_id when the record does not exist yet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not