> ## 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

> Gestisci contatti, campagne, risposte e mittenti di Emailx dal tuo codice.

L’API di Emailx permette al tuo codice di fare quello che fai nell’app: aggiungere contatti, preparare e avviare campagne, rispondere e seguire i risultati. Scambia JSON all’indirizzo `https://app.emailx.ai/api/v1`.

> [card] [Trovare l’endpoint giusto](https://docs.emailx.ai/it/api-reference/find-endpoint.md)
>
> Parti da un’attività, per esempio avviare una campagna, e scopri quali chiamate fare e in che ordine.

## Come è organizzata la reference

Le sezioni della barra laterale seguono la vita di una campagna:

1. **Per iniziare**: controlla la chiave e scegli un workspace.
2. **Contatti** e **Importare contatti**: aggiungi le persone da raggiungere.
3. **Preparare una campagna** e **Aggiungere prospect**: crea una bozza e inserisci le persone.
4. **Avviare su LinkedIn**, oppure **Scrivere e approvare le email** e poi **Avviare le email**.
5. **Gestire una campagna attiva**, **Inbox e risposte** e **Report**: segui e correggi.

Le altre sezioni riguardano mittenti, template, knowledge, webhook, team, domini e clienti dell’agenzia.

## Le basi

| | |
| - | - |
| Indirizzo | `https://app.emailx.ai/api/v1` |
| Autenticazione | `Authorization: Bearer <la tua chiave API>` ([come ottenere una chiave](https://docs.emailx.ai/it/overview/authentication.md)) |
| Risposte | JSON, con il risultato in `data`; gli elenchi arrivano a pagine |
| Modifiche | Invia l’header `Idempotency-Key`, così una chiamata ripetuta non viene eseguita due volte |

Le chiamate che avviano una campagna, inviano un messaggio, usano crediti AI o portano a un acquisto richiedono anche un campo di conferma esplicito, per esempio `confirm_launch: true`. Niente di importante succede per errore.

Alcune azioni, come avvii, importazioni e risposte, vengono eseguite in background. Restituiscono subito un’attività da seguire in [Attività in background](https://docs.emailx.ai/it/api-reference/jobs/get-job.md), oppure puoi ricevere un avviso con un [webhook](https://docs.emailx.ai/it/overview/webhooks).

Prima di iniziare leggi [paginazione](https://docs.emailx.ai/it/api-reference/pagination.md), [nuovi tentativi e idempotenza](https://docs.emailx.ai/it/api-reference/idempotency.md), [limiti delle richieste](https://docs.emailx.ai/it/api-reference/rate-limits.md) ed [errori](https://docs.emailx.ai/it/api-reference/errors.md). Gli esempi in ogni pagina usano dati inventati.

## Download

* [Contratto OpenAPI](https://app.emailx.ai/api/openapi.json)
* [Collection Postman](https://app.emailx.ai/api/postman.json)
* [Pacchetto CLI e MCP](https://app.emailx.ai/api/emailx-agent.zip)


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