Base URL: https://elixmail.fr/api/v1 · Format: JSON (UTF-8) · Auth: API key (Bearer).
1. Authentication
Every request must carry your API key:
Authorization: Bearer elx_live_xxxxxxxxxxxxxxxxxxxxxxxx
Create a key in Elixmail under Settings → API & Zapier → “Create key”. The full key is shown only once (stored hashed, never in clear text). Keys can be revoked anytime.
Rate limit: 120 requests / minute / key. Beyond that: 429 Too Many Requests with a Retry-After header. A revoked key returns 401.
2. Auth test
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/me | Returns { authenticated, email, auth_method }. Used as the Zapier connection test. |
3. Triggers (read — polling)
Return a JSON array sorted by creation date (newest first). Each item has a unique id (dedup key) and created_at. Optional query params: since (ISO 8601) and limit (default 50, max 200).
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/contacts | Recent contacts (trigger “New Contact”). |
| GET | /api/v1/deals | Recent deals (trigger “New Deal”). |
curl -H "Authorization: Bearer elx_live_xxx" \ "https://elixmail.fr/api/v1/contacts?since=2026-06-01T00:00:00Z&limit=50"
4. Actions (write)
| Action | Method | Endpoint | Key fields |
|---|---|---|---|
| Send email | POST | /api/emails/send | to, subject, body, cc, bcc |
| Create contact | POST | /api/v1/contacts | email, full_name, company, phone, tags |
| Create deal | POST | /api/deals | contactEmail, subject, value, currency, stage |
5. Data scope & security
All data is strictly scoped to the account that owns the API key. Keys are SHA-256 hashed at rest. All traffic is HTTPS only.