> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Espocrm

> EspoCRM is an open-source web application that allows businesses to manage their customer relationships effectively.

![Espocrm logo](https://mintcdn.com/composio-preview/r7CO9m4_UWMVFnU7/images/toolkits/espocrm.svg?fit=max\&auto=format\&n=r7CO9m4_UWMVFnU7\&q=85\&s=35bed3ab77427aa01b720358ca6e8304)

* **Category:** crm
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 16
* **Triggers:** 0
* **Slug:** `ESPOCRM`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Record
>
> **Slug:** `ESPOCRM_CREATE_RECORD`
>
> Create a record for any standard or custom EspoCRM entity type.
>
> #### Input Parameters
>
> **attributes** `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.
>
> **entity\_type** `string` *required*
>
> EspoCRM entity type to create, such as Account, Contact, or a custom entity type from Entity Manager.
>
> **skip\_duplicate\_check** `boolean`
>
> Set true to bypass EspoCRM's duplicate-record check for this creation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Download Attachment
>
> **Slug:** `ESPOCRM_DOWNLOAD_ATTACHMENT`
>
> Download an EspoCRM attachment by attachment record ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique ID of the EspoCRM attachment record.
>
> **file\_name** `string` *required*
>
> Safe output filename for the downloaded attachment, including its extension.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Follow Record
>
> **Slug:** `ESPOCRM_FOLLOW_RECORD`
>
> Follow an EspoCRM record so its updates appear in the user's stream.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> Unique ID of the EspoCRM record.
>
> **entity\_type** `string` *required*
>
> EspoCRM entity type of the record.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get App User
>
> **Slug:** `ESPOCRM_GET_APP_USER`
>
> Tool to retrieve current user data including token, ACL, and preferences. Use after successful authentication to fetch session-specific profile.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Currency Rates
>
> **Slug:** `ESPOCRM_GET_CURRENCY_RATES`
>
> Retrieve the currency rates configured in EspoCRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Labels
>
> **Slug:** `ESPOCRM_GET_LABELS`
>
> Retrieve all EspoCRM labels in the user or system default language.
>
> #### Input Parameters
>
> **default** `boolean`
>
> Set true to force labels to use the system default language.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Metadata
>
> **Slug:** `ESPOCRM_GET_METADATA`
>
> Retrieve available EspoCRM application metadata or one metadata path. The returned metadata is JSON-encoded in string fields.
>
> #### Input Parameters
>
> **key** `string`
>
> Dot-separated metadata path to return, such as entityDefs.Lead.fields.status.options. Omit to return all available metadata.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Record
>
> **Slug:** `ESPOCRM_GET_RECORD`
>
> Retrieve one standard or custom EspoCRM entity record by its ID.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> Unique ID of the record to retrieve.
>
> **entity\_type** `string` *required*
>
> EspoCRM entity type, including a tenant-defined custom entity type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Records
>
> **Slug:** `ESPOCRM_LIST_RECORDS`
>
> List one page of records for any standard or custom EspoCRM entity type.
>
> #### Input Parameters
>
> **order** `string ("asc" | "desc")`
>
> Sort direction: asc or desc.
>
> **where** `array`
>
> Structured EspoCRM filters. Use either where or its firewall-safe alias whereGroup, not both.
>
> **offset** `integer`
>
> Zero-based record offset for this page.
>
> **select** `string`
>
> Comma-separated attributes to return, without whitespace. Omit to return all attributes.
>
> **max\_size** `integer`
>
> Maximum number of records to return in this page.
>
> **no\_total** `boolean`
>
> Set true to omit the total count for a faster query on large tables.
>
> **order\_by** `string`
>
> Entity attribute to sort by.
>
> **entity\_type** `string` *required*
>
> Entity type to list, such as Account, Contact, or a custom entity type.
>
> **where\_group** `array`
>
> EspoCRM v9.0+ firewall-safe alias of where with identical filter semantics.
>
> **primary\_filter** `string`
>
> Entity-specific primary filter defined by the instance, such as open.
>
> **attribute\_select** `string`
>
> EspoCRM v9.0+ firewall-safe alias of select with identical comma-separated attribute semantics.
>
> **bool\_filter\_list** `array`
>
> Entity-specific boolean filters, such as onlyMy or followed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Record Stream
>
> **Slug:** `ESPOCRM_LIST_RECORD_STREAM`
>
> List one page of stream notes for a standard or custom EspoCRM record.
>
> #### Input Parameters
>
> **offset** `integer`
>
> Zero-based stream note offset.
>
> **max\_size** `integer`
>
> Maximum number of stream notes to return.
>
> **record\_id** `string` *required*
>
> Unique ID of the EspoCRM record.
>
> **entity\_type** `string` *required*
>
> EspoCRM entity type of the record.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Related Records
>
> **Slug:** `ESPOCRM_LIST_RELATED_RECORDS`
>
> List one page of records connected to a source record through a named link.
>
> #### Input Parameters
>
> **link** `string` *required*
>
> Relationship link name from EspoCRM Entity Manager.
>
> **order** `string ("asc" | "desc")`
>
> Sort direction: asc or desc.
>
> **where** `array`
>
> Structured EspoCRM filters applied to the related records.
>
> **offset** `integer`
>
> Zero-based related-record offset for this page.
>
> **select** `string`
>
> Comma-separated related-record attributes to return, without whitespace.
>
> **max\_size** `integer`
>
> Maximum number of related records to return in this page, up to 200.
>
> **order\_by** `string`
>
> Related-record attribute to sort by.
>
> **record\_id** `string` *required*
>
> ID of the source record.
>
> **entity\_type** `string` *required*
>
> Entity type of the source record, such as Account or Contact.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Stream
>
> **Slug:** `ESPOCRM_LIST_STREAM`
>
> List one page of stream notes visible to the current EspoCRM user.
>
> #### Input Parameters
>
> **offset** `integer`
>
> Zero-based stream note offset.
>
> **max\_size** `integer`
>
> Maximum number of stream notes to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Post Stream Note
>
> **Slug:** `ESPOCRM_POST_STREAM_NOTE`
>
> Post a note to an EspoCRM record stream, optionally with attachments.
>
> #### Input Parameters
>
> **post** `string` *required*
>
> Text to post to the record stream.
>
> **parent\_id** `string` *required*
>
> ID of the record to post to.
>
> **parent\_type** `string` *required*
>
> Entity type of the record to post to.
>
> **attachments\_ids** `array`
>
> IDs of attachments that were uploaded separately beforehand.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Relate Records
>
> **Slug:** `ESPOCRM_RELATE_RECORDS`
>
> Relate one or more existing records through a named EspoCRM link.
>
> #### Input Parameters
>
> **link** `string` *required*
>
> Relationship link name from EspoCRM Entity Manager.
>
> **where** `array`
>
> Required search criteria when mass\_relate is true; omit for explicit IDs.
>
> **record\_id** `string` *required*
>
> ID of the source record.
>
> **entity\_type** `string` *required*
>
> Entity type of the source record, such as Account or Contact.
>
> **mass\_relate** `boolean`
>
> Set true to relate every record matching where instead of explicit IDs.
>
> **related\_record\_id** `string`
>
> ID of one existing record to relate. Use this or related\_record\_ids, not both.
>
> **related\_record\_ids** `array`
>
> Non-empty IDs of existing records to relate. Use this or related\_record\_id, not both.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Record
>
> **Slug:** `ESPOCRM_UPDATE_RECORD`
>
> Partially update any standard or custom EspoCRM entity record.
>
> #### Input Parameters
>
> **changes** `object` *required*
>
> Non-empty map of EspoCRM field names to provider-native JSON values. Only supplied fields are updated.
>
> **record\_id** `string` *required*
>
> ID of the EspoCRM record to update.
>
> **entity\_type** `string` *required*
>
> EspoCRM entity type, such as Account or a custom entity name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload Attachment
>
> **Slug:** `ESPOCRM_UPLOAD_ATTACHMENT`
>
> Upload a file for an EspoCRM File or Attachment-Multiple field.
>
> #### Input Parameters
>
> **file** `object` *required*
>
> File to upload to EspoCRM.
>
> **field** `string` *required*
>
> Name of the File or Attachment-Multiple field that will hold the attachment.
>
> **related\_id** `string`
>
> Existing record ID containing the File field. Requires related\_type.
>
> **parent\_type** `string`
>
> Entity type containing an Attachment-Multiple field. Do not combine with related\_type or related\_id.
>
> **related\_type** `string`
>
> Entity type containing a File field. May be used without related\_id when the record does not exist yet.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
