> For the complete documentation index, see [llms.txt](https://docs.coupler.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.coupler.io/sources/category/crm/agilecrm.md).

# AgileCRM

Connect AgileCRM contacts, companies, and deals to Google Sheets or BigQuery via Coupler.io for automated CRM reporting.

AgileCRM is an all-in-one CRM platform that combines sales, marketing, and customer service tools in a single place. It helps small and mid-sized businesses manage contacts, track deals, run email campaigns, and handle support tickets without switching between apps.

Connecting AgileCRM to Coupler.io lets you pull your CRM data into spreadsheets, dashboards, or data warehouses automatically — no manual exports needed.

## Why connect AgileCRM to Coupler.io?

* **Automate reporting** — schedule regular data syncs so your reports are always up to date
* **Centralize your data** — combine AgileCRM data with other sources like ad platforms or billing tools
* **Build custom dashboards** — send data to Google Sheets, Looker Studio, Power BI, or BigQuery
* **Track pipeline health** — monitor deals, tasks, and milestones without logging into AgileCRM

## Prerequisites

Before you connect, make sure you have:

* An active AgileCRM account
* Your AgileCRM **domain** (the subdomain in your AgileCRM URL, e.g., `yourcompany` from `yourcompany.agilecrm.com`)
* Your AgileCRM **email address** (the one you use to log in)
* Your AgileCRM **REST API key** (found in your AgileCRM account under Admin Settings → API & Analytics)

## Quick start

{% hint style="success" %}
Before setting up your first importer, grab your API key from AgileCRM's Admin Settings page. Keep it handy — you'll need it during the connection step.
{% endhint %}

{% stepper %}
{% step %}
**Create a new data flow in Coupler.io** and select **AgileCRM** as your data source.
{% endstep %}

{% step %}
**Enter your AgileCRM credentials.** Provide your AgileCRM domain (just the subdomain, not the full URL), your login email address, and your REST API key.
{% endstep %}

{% step %}
**Choose an entity to import.** Select which type of data you want to pull — for example, Contacts, Deals, or Tickets. See the table below for all available entities.
{% endstep %}

{% step %}
**Configure your destination.** Choose where you want your data to land — Google Sheets, Excel, BigQuery, or another supported destination — and map the fields as needed.
{% endstep %}

{% step %}
**Run your data flow.** Click **Run** to do a manual test first. Once everything looks right, set a **refresh schedule** so your data stays current automatically.
{% endstep %}
{% endstepper %}

## AgileCRM data overview

AgileCRM gives you access to a wide range of CRM data across sales, marketing, and support. When you connect through Coupler.io, you can pull structured data from any of the available entities and use it in your reports and dashboards.

## Available entities

| Entity         | What it contains                                                               |
| -------------- | ------------------------------------------------------------------------------ |
| Contacts       | Contact records with properties, tags, lead score, owner, and activity history |
| Companies      | Company profiles with industry, size, website, and linked contacts             |
| Deals          | Deal name, value, stage, probability, close date, and assigned owner           |
| Notes          | Note content, associated record (contact/company/deal), author, and timestamp  |
| Tasks          | Task subject, type, due date, status, priority, and assignee                   |
| Events         | Event title, start/end time, associated contact, and attendees                 |
| Milestones     | Pipeline stage names, order, and probability percentages                       |
| Campaigns      | Campaign name, status, type, stats, and creation date                          |
| Documents      | Document name, type, associated contact or deal, and upload date               |
| Ticket filters | Filter name, conditions, and associated ticket view settings                   |
| Tickets        | Ticket subject, status, priority, assignee, requester, and timestamps          |

## Contacts

#### Key fields

| Field                    | Description                             |
| ------------------------ | --------------------------------------- |
| id                       | Unique contact identifier               |
| first\_name / last\_name | Contact's full name                     |
| email                    | Primary email address                   |
| phone                    | Phone number                            |
| lead\_score              | Numeric lead score assigned in AgileCRM |
| tags                     | List of tags applied to the contact     |
| owner                    | Team member responsible for the contact |
| created\_time            | Timestamp when the contact was created  |
| updated\_time            | Timestamp of the last update            |

## Companies

#### Key fields

| Field             | Description                 |
| ----------------- | --------------------------- |
| id                | Unique company identifier   |
| name              | Company name                |
| url               | Company website             |
| industry          | Industry category           |
| no\_of\_employees | Estimated employee count    |
| tags              | Tags applied to the company |
| created\_time     | Record creation timestamp   |

## Deals

#### Key fields

| Field           | Description                      |
| --------------- | -------------------------------- |
| id              | Unique deal identifier           |
| name            | Deal name                        |
| expected\_value | Monetary value of the deal       |
| probability     | Percentage likelihood of closing |
| milestone       | Current pipeline stage           |
| close\_date     | Expected close date              |
| owner           | Assigned sales rep               |
| contacts        | Linked contact records           |
| created\_time   | Deal creation timestamp          |

## Tasks

#### Key fields

| Field    | Description                              |
| -------- | ---------------------------------------- |
| id       | Unique task identifier                   |
| subject  | Task title or description                |
| type     | Task type (call, email, follow-up, etc.) |
| due      | Due date and time                        |
| status   | Open or completed                        |
| priority | Low, normal, or high                     |
| owner    | Assigned team member                     |

## Tickets

#### Key fields

| Field            | Description                               |
| ---------------- | ----------------------------------------- |
| id               | Unique ticket identifier                  |
| subject          | Ticket title                              |
| status           | Open, closed, resolved, etc.              |
| priority         | Urgency level                             |
| group            | Support group assigned                    |
| assignee         | Agent handling the ticket                 |
| requester\_email | Email of the person who raised the ticket |
| created\_time    | Ticket creation timestamp                 |
| updated\_time    | Last update timestamp                     |

## Common field combinations

Here are some useful ways to combine fields across entities:

* **Deal pipeline report** — Deals `name` + `milestone` + `expected_value` + `close_date` + `owner`
* **Contact engagement report** — Contacts `email` + `lead_score` + `tags` + `updated_time`
* **Support workload report** — Tickets `assignee` + `status` + `priority` + `created_time`
* **Campaign performance overview** — Campaigns `name` + `status` + `type` + `created_time`
* **Task completion tracking** — Tasks `subject` + `type` + `due` + `status` + `owner`

## Use cases by role

{% tabs %}
{% tab title="Sales teams" %}

* Track open deals by stage and owner to spot pipeline gaps
* Monitor lead scores to prioritize outreach
* Report on deal close rates and average deal values over time
* Use milestones data to analyze how deals progress through the pipeline
  {% endtab %}

{% tab title="Marketers" %}

* Pull campaign data into dashboards to compare performance across campaigns
* Analyze contact tags and lead scores to segment audiences
* Track new contact creation over time to measure inbound growth
* Cross-reference campaign data with deal creation to measure campaign-to-revenue attribution
  {% endtab %}

{% tab title="Support teams" %}

* Monitor open ticket volume, priority distribution, and resolution time
* Track tickets by assignee to balance team workload
* Use ticket filter data to replicate saved views in external reporting tools
* Identify trends in ticket creation to anticipate support demand
  {% endtab %}
  {% endtabs %}

## Platform-specific notes

* AgileCRM uses Unix timestamps for `created_time` and `updated_time` fields — you may need to convert these in your destination tool
* Custom fields defined in your AgileCRM account will appear in the data but field names may vary depending on your configuration
* The **Milestones** entity returns pipeline stage definitions, not individual deal stages — use the `milestone` field in Deals for per-deal stage data
* **Ticket filters** returns saved filter configurations, not the tickets themselves — use the **Tickets** entity to get actual ticket records
* Lead score values are cumulative and reflect all scoring activity up to the time of the sync

## AgileCRM common issues

### Connection issues

<details>

<summary>My API key isn't working</summary>

Double-check that you're using the **REST API key** from AgileCRM, not a different credential. You can find it under **Admin Settings → API & Analytics** in your AgileCRM account. Make sure there are no extra spaces when you paste the key into Coupler.io.

</details>

<details>

<summary>I get an authentication error even though my credentials look correct</summary>

Make sure you're entering your credentials exactly as follows:

* **Domain** — just the subdomain (e.g., `yourcompany`), not the full URL
* **Email** — the email address you use to log in to AgileCRM
* **API key** — copied directly from AgileCRM's Admin Settings page

If you recently reset your API key in AgileCRM, you'll need to update it in Coupler.io as well.

</details>

<details>

<summary>My data flow times out during the connection test</summary>

This can happen if your AgileCRM account has a very large dataset. Try running the data flow on a smaller entity first (like Milestones or Ticket Filters) to confirm the connection works. If the timeout persists on large entities, contact Coupler.io support.

</details>

### Missing data

<details>

<summary>Some contacts or deals are missing from my export</summary>

AgileCRM's API returns data in paginated batches. If your account has a very large number of records, occasional gaps can occur. Try re-running the data flow. If data is consistently missing, check whether the missing records are accessible to your user under their permissions in AgileCRM.

</details>

<details>

<summary>Custom fields aren't showing up in my data</summary>

Custom fields should appear in the exported data, but their names depend on how they're defined in your AgileCRM account. Check your AgileCRM custom field configuration under **Admin Settings** and look for matching field names in the exported columns.

</details>

<details>

<summary>The Tickets entity returns no data</summary>

Make sure your AgileCRM plan includes the helpdesk/ticketing feature — not all plans do. Also, confirm that tickets exist in your account and that your API key belongs to a user with access to the helpdesk module.

</details>

### Permission errors

<details>

<summary>I see a 403 Forbidden error</summary>

This usually means the AgileCRM user account associated with your API key doesn't have permission to access the entity you're trying to import. Check that your user has admin-level or appropriate role permissions in AgileCRM. Only admin users can access all entities via the API.

{% hint style="warning" %}
Non-admin users in AgileCRM may have restricted API access. Use an admin account's API key for full data access.
{% endhint %}

</details>

### Data discrepancies

<details>

<summary>Timestamps look wrong or unreadable</summary>

AgileCRM returns timestamps as Unix epoch values (milliseconds). You'll need to convert these in your destination tool. In Google Sheets, you can use a formula like `=(A1/1000/86400)+DATE(1970,1,1)` and format the cell as a date.

</details>

<details>

<summary>Deal counts in Coupler.io don't match what I see in AgileCRM</summary>

AgileCRM's UI may apply default filters (such as showing only open deals) that aren't applied in the API. Coupler.io returns all records unless filters are applied. Check whether deleted or archived deals are being included in your export.

</details>

### Rate limits

<details>

<summary>My sync fails with a rate limit error</summary>

AgileCRM enforces API rate limits that vary by plan. If you're hitting rate limits, try scheduling your syncs less frequently or during off-peak hours. Avoid running multiple AgileCRM data flows at the same time, as each one counts toward your API quota.

</details>

## AgileCRM FAQ

<details>

<summary>Where do I find my AgileCRM API key?</summary>

Log in to your AgileCRM account and go to **Admin Settings → API & Analytics**. Your REST API key is listed there. Only admin users can access this section, so make sure you're logged in with an admin account.

</details>

<details>

<summary>What should I enter as my AgileCRM domain?</summary>

Enter just the subdomain part of your AgileCRM URL. For example, if your AgileCRM URL is `yourcompany.agilecrm.com`, enter `yourcompany` — not the full URL.

</details>

<details>

<summary>Why do my date fields show large numbers instead of readable dates?</summary>

AgileCRM stores dates as Unix timestamps in milliseconds. You'll need to convert them in your destination tool. In Google Sheets, use a formula to divide by 1000, then divide by 86400, and add the date origin. In BigQuery, use `TIMESTAMP_MILLIS()`. Check out the Data Overview article for more context on field formats.

</details>

<details>

<summary>Does Coupler.io support filtering AgileCRM data before import?</summary>

Coupler.io pulls all available records from each AgileCRM entity. Filtering isn't applied at the source level. You can filter and transform the data after it lands in your destination — for example, using spreadsheet formulas, BigQuery views, or your BI tool's built-in filters.

</details>

<details>

<summary>Which AgileCRM plan do I need to use the API?</summary>

API access is available on AgileCRM's paid plans. Free accounts have limited or no API access. If you're having trouble connecting, check whether your plan includes API access under your AgileCRM billing or admin settings.

</details>

<details>

<summary>Can non-admin users connect AgileCRM to Coupler.io?</summary>

Technically yes, but non-admin users have restricted API access in AgileCRM and may not be able to pull all entities. For the best results and full data access, use an admin account's API key. See the Common Issues article for more on permission errors.

</details>

<details>

<summary>How often can I sync my AgileCRM data?</summary>

This depends on your AgileCRM plan's API rate limits and your Coupler.io subscription. In general, daily or hourly syncs work well for most use cases. Avoid running multiple imports simultaneously to stay within rate limits.

</details>

<details>

<summary>What happens if I regenerate my AgileCRM API key?</summary>

If you regenerate your API key in AgileCRM, your existing Coupler.io data flows will stop working immediately. You'll need to update the API key in each of your AgileCRM data flows in Coupler.io to restore the connection.

</details>

{% hint style="info" %}
For details on what fields are available for each entity, see the [Data Overview](#agilecrm-data-overview) article. If you're running into sync errors or missing records, check the [Common Issues](#agilecrm-common-issues) article. For tips on getting the most out of your integration, visit [Best Practices](https://docs.coupler.io/sources/category/crm/agilecrm/best-practices.md).
{% endhint %}


---

# 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.coupler.io/sources/category/crm/agilecrm.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.
