+1 (408) 320-0380

API Documentation

EspoCRM’s API lets you connect your CRM to your website and other business systems. Once connected, leads, contacts, tasks, and other records are created automatically — saving your team from manual data entry.

Common Use Cases

Leads

Web-to-Lead Capture

A visitor fills out a form on your website, and a new lead is created in EspoCRM automatically with their name, email, phone number, and source.

Sync

Customer data sync

Keep your CRM in sync with your accounting software, e-commerce platform, or marketing tools so your team always has current contact and order information.

Automation

Automated record creation

When an event happens in an external system (a support ticket is opened, a payment is received), your integration creates or updates the matching record in EspoCRM.

Data

Reporting and dashboards

Pull CRM data into external reporting or BI tools using GET requests with search parameters to filter, sort, and select specific fields.

Quick Start

1. Create an API User

Go to Administration > API Users. Choose your authentication method (API Key or HMAC) and save the generated credentials.

2. Assign a Role

Go to Administration > Roles, create a role with the permissions your integration needs (for example, create and read access to Leads only), and link it to your API User.

3. Make your first request

Send a request to your EspoCRM instance URL followed by /api/v1/ and the entity type.

For example:

GET https://your-espocrm-site/api/v1/Contact/55643ca033f7ab4c5