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

# API Reference

> Manage contacts, campaigns, replies and senders in Emailx from your own code.

The Emailx API lets your code do what you do in the app: add contacts, build and launch campaigns, answer replies and follow results. It sends and receives JSON at `https://app.emailx.ai/api/v1`.

> [card] [Find the right endpoint](https://docs.emailx.ai/en/api-reference/find-endpoint.md)
>
> Start from a task, such as launching a campaign, and see which calls to make, in order.

## How the reference is organized

The sections in the sidebar follow the life of a campaign:

1. **Start here**: check your key and pick a workspace.
2. **Contacts** and **Import contacts**: add the people you want to reach.
3. **Set up a campaign** and **Add prospects**: create a draft and put people in it.
4. **Launch on LinkedIn**, or **Write and approve emails** then **Launch email**.
5. **Run a live campaign**, **Inbox and replies** and **Reports**: follow and adjust.

The other sections cover senders, templates, knowledge, webhooks, your team, domains and agency clients.

## The basics

| | |
| - | - |
| Address | `https://app.emailx.ai/api/v1` |
| Authentication | `Authorization: Bearer <your API key>` ([how to get a key](https://docs.emailx.ai/en/overview/authentication.md)) |
| Responses | JSON, with the result in `data`; lists come in pages |
| Changes | Send an `Idempotency-Key` header, so a retried call never runs twice |

Calls that launch a campaign, send a message, use AI credits or lead to a purchase also need an explicit confirmation field, such as `confirm_launch: true`. Nothing consequential happens by accident.

Some actions, such as launches, imports and replies, run in the background. They return a background job right away; follow it in [Background jobs](https://docs.emailx.ai/en/api-reference/jobs/get-job.md) or get notified with a [webhook](https://docs.emailx.ai/en/overview/webhooks).

Before building, read [pagination](https://docs.emailx.ai/en/api-reference/pagination.md), [retries and idempotency](https://docs.emailx.ai/en/api-reference/idempotency.md), [request limits](https://docs.emailx.ai/en/api-reference/rate-limits.md) and [errors](https://docs.emailx.ai/en/api-reference/errors.md). Examples on every page use made-up data.

## Downloads

* [OpenAPI contract](https://app.emailx.ai/api/openapi.json)
* [Postman collection](https://app.emailx.ai/api/postman.json)
* [CLI and MCP package](https://app.emailx.ai/api/emailx-agent.zip)


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