> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# EspoCRM - How do I link my account?

## Overview

To authenticate with EspoCRM, you need:

1. **EspoCRM Host** — the host of your EspoCRM instance, for example `crm.example.com`.
2. **API Key** — the API key of an EspoCRM API user.

This guide will show you how to find both.

### Prerequisites

* An EspoCRM instance, self-hosted or on [EspoCRM Cloud](https://www.espocrm.com/cloud-registration/). EspoCRM Cloud offers a 30-day free trial.
* An administrator account on that instance. API users are created under **Administration**.

### Step 1: Find your EspoCRM host

1. Open your EspoCRM instance in your browser.
2. Copy the host from the address bar, without `https://` or any path. On EspoCRM Cloud it looks like `yourcompany.espocloud.com`; on a self-hosted install it is your own domain, such as `crm.example.com`.

### Step 2: Create a role for the API user

An API user can only access what its role allows, so create a role that covers the data your integration needs.

1. In EspoCRM, open **Administration** and, under **Users**, click **Roles**.

![EspoCRM Administration page with the Roles link under Users](https://mintcdn.com/nango/sAwU7ss2B_vZyzM9/api-integrations/espocrm/admin_roles_link.png?fit=max\&auto=format\&n=sAwU7ss2B_vZyzM9\&q=85\&s=9f3ae651dcb6df345a4829127063479d)

2. Create a new role and enter a **Name**.
3. Under **Scope Level**, set **Access** to **enabled** for each entity the integration needs (for example Accounts and Contacts), and choose the **Create**, **Read**, **Edit** and **Delete** levels it should have.
4. Click **Save**.

![EspoCRM role creation form with the role name, permissions and the Save button](https://mintcdn.com/nango/sAwU7ss2B_vZyzM9/api-integrations/espocrm/create_read_only_role.png?fit=max\&auto=format\&n=sAwU7ss2B_vZyzM9\&q=85\&s=71da5055fd5304a64ee430df98f80e64)

### Step 3: Create an API user

1. Go back to **Administration** and, under **Users**, click **API Users**, then click **Create API User**.
2. Enter a **User Name** and select the role from Step 2 under **Roles**.
3. Leave **Authentication Method** set to **API Key**, then click **Save**.

![EspoCRM Create API User form with a user name, a role and the API Key authentication method](https://mintcdn.com/nango/sAwU7ss2B_vZyzM9/api-integrations/espocrm/create_api_user.png?fit=max\&auto=format\&n=sAwU7ss2B_vZyzM9\&q=85\&s=bdc3207e3ab0560251ba33ddb7d7c3de)

4. On the API user's detail view, click the copy button next to **API Key** to copy the key.

![EspoCRM API user detail view with the copy button next to the API Key](https://mintcdn.com/nango/sAwU7ss2B_vZyzM9/api-integrations/espocrm/api_key_created.png?fit=max\&auto=format\&n=sAwU7ss2B_vZyzM9\&q=85\&s=86f6e507fdc1997c544cd6d3dc72d6ac)

### Step 4: Enter your credentials in the Connect UI

1. Open the form where you need to authenticate with EspoCRM.
2. In **EspoCRM Host**, enter your host from Step 1 (for example, `crm.example.com`).
3. In **API Key**, paste the API key from Step 3.
4. Submit the form. Nango checks the API key with your EspoCRM instance before saving the connection.

![EspoCRM Connect UI form with the EspoCRM Host and API Key fields](https://mintcdn.com/nango/sAwU7ss2B_vZyzM9/api-integrations/espocrm/form.png?fit=max\&auto=format\&n=sAwU7ss2B_vZyzM9\&q=85\&s=4669dd17bc62fceb108f0f4703f18d9a)

You are now connected to EspoCRM.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.