> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/espocrm.md).

# EspoCRM

Create, update, and search core records in a self-hosted EspoCRM site.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| EspoCRM   | API Key        |

#### EspoCRM

Connect to a self-hosted EspoCRM site with an API User key.

**Set up in EspoCRM**

1. Prepare the EspoCRM account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Create an API User with API Key authentication and the roles this workflow needs.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **EspoCRM**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                                                                                         |
| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Site URL      | Yes      | The HTTPS URL you open in a browser for this EspoCRM installation. Include any installation subpath, but do not add '/api/v1'. HTTPS is required to protect your API key and CRM data in transit. [Provider instructions](https://docs.espocrm.com/development/api/). |
| API Key       | Yes      | Create an API User with API Key authentication and the roles this workflow needs. [Provider instructions](https://docs.espocrm.com/development/api/).                                                                                                                 |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **EspoCRM** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Contact

Create a contact in EspoCRM and optionally link it to an account.

**Inputs**

| Field         | Type            | Required | Description                                                 |
| ------------- | --------------- | -------- | ----------------------------------------------------------- |
| First Name    | string          | No       | The contact's first name.                                   |
| Last Name     | string          | Yes      | The contact's required last name.                           |
| Job Title     | string          | No       | The contact's job title.                                    |
| Email Address | string          | No       | The contact's email address.                                |
| Phone Number  | string          | No       | The contact's phone number.                                 |
| Account       | select (string) | No       | Account to link. Options load from the selected connection. |
| Description   | textarea        | No       | Additional details about the contact.                       |

**Outputs**

| Field       | Type   | Description                      |
| ----------- | ------ | -------------------------------- |
| Record ID   | string | The created contact's record ID. |
| Entity Type | string | The type of the created record.  |

#### Create Lead

Create a lead in EspoCRM with core identity and contact details.

**Inputs**

| Field         | Type     | Required | Description                               |
| ------------- | -------- | -------- | ----------------------------------------- |
| First Name    | string   | No       | The lead's first name.                    |
| Last Name     | string   | No       | The lead's last name.                     |
| Job Title     | string   | No       | The lead's role or job title.             |
| Email Address | string   | No       | The lead's primary email address.         |
| Phone Number  | string   | No       | The lead's primary phone number.          |
| Account Name  | string   | No       | Company/account associated with the lead. |
| Description   | textarea | No       | Notes that help qualify or follow up.     |

**Outputs**

| Field       | Type   | Description                 |
| ----------- | ------ | --------------------------- |
| Record ID   | string | The ID of the created lead. |
| Entity Type | string | The type of record created. |

#### Create Opportunity

Create a sales opportunity in EspoCRM with its value and expected close date.

**Inputs**

| Field               | Type            | Required | Description                                                                                   |
| ------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------- |
| Opportunity Name    | string          | Yes      | Name of the sales opportunity.                                                                |
| Amount              | number          | Yes      | Value of the opportunity.                                                                     |
| Currency            | string          | Yes      | Three-letter currency code configured in EspoCRM.                                             |
| Expected Close Date | date            | Yes      | Expected date the opportunity will close.                                                     |
| Account             | select (string) | No       | Optional account associated with this opportunity. Options load from the selected connection. |
| Contact             | select (string) | No       | Optional contact associated with this opportunity. Options load from the selected connection. |
| Description         | textarea        | No       | Optional details about the opportunity.                                                       |

**Outputs**

| Field       | Type   | Description                          |
| ----------- | ------ | ------------------------------------ |
| Record ID   | string | ID of the created opportunity.       |
| Entity Type | string | Type of the record that was created. |

#### Search Records

Search EspoCRM accounts, contacts, leads, or opportunities by text.

**Inputs**

| Field           | Type            | Required | Description                                                                      |
| --------------- | --------------- | -------- | -------------------------------------------------------------------------------- |
| Record Type     | select (string) | Yes      | Type of record to search. Available values: Account, Contact, Lead, Opportunity. |
| Search Text     | string          | Yes      | Text to find in records.                                                         |
| Maximum Results | integer         | No       | Maximum number of records to return. Minimum: 1. Maximum: 100. Default: 25.      |
| Starting Offset | integer         | No       | Starting position for a continued search. Minimum: 0. Default: 0.                |

**Outputs**

| Field        | Type          | Description                                                |
| ------------ | ------------- | ---------------------------------------------------------- |
| Records      | object\_array | Matching records with their IDs and names.                 |
| Record Count | integer       | Number of records returned.                                |
| Next Offset  | integer       | Offset for the next page, when more records are available. |

#### Update Record

Update selected fields on an EspoCRM contact, lead, or opportunity.

**Inputs**

| Field               | Type            | Required | Description                                                                     |
| ------------------- | --------------- | -------- | ------------------------------------------------------------------------------- |
| Record Type         | select (string) | Yes      | Type of record to update. Available values: Contact, Lead, Opportunity.         |
| Record              | select (string) | Yes      | Record to update. Options load from the selected connection.                    |
| First Name          | string          | No       | Updated first name.                                                             |
| Last Name           | string          | No       | Updated last name.                                                              |
| Job Title           | string          | No       | Updated job title.                                                              |
| Email Address       | string          | No       | Updated email address.                                                          |
| Phone Number        | string          | No       | Updated phone number.                                                           |
| Account Name        | string          | No       | Updated lead account name.                                                      |
| Opportunity Name    | string          | No       | Updated opportunity name.                                                       |
| Amount              | number          | No       | Updated opportunity amount.                                                     |
| Currency            | string          | No       | Updated opportunity currency.                                                   |
| Expected Close Date | date            | No       | Updated expected close date.                                                    |
| Account             | select (string) | No       | Account to link to this record. Options load from the selected connection.      |
| Contact             | select (string) | No       | Contact to link to this opportunity. Options load from the selected connection. |
| Description         | textarea        | No       | Updated record description.                                                     |

**Outputs**

| Field       | Type   | Description               |
| ----------- | ------ | ------------------------- |
| Record ID   | string | ID of the updated record. |
| Record Type | string | Type of updated record.   |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/espocrm.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
