API Reference
Getting Started
The conventions guide that lived on this page grew into dedicated pages: a five-minute quickstart and six concept pages. This page is the map — and the anchor index that error doc_url links point at.
curl "https://api.mailneo.co/api/v2/me" \
-H "x-api-key: $MAILNEO_API_KEY"Start here
QuickstartAuthenticate, load your audience, and preview your first send.AuthenticationKeys, the scope model, rotation, and OAuth for integrations.Pagination & syncCursors, has_more, and incremental sync with updated_since.ErrorsThe error envelope, every code, and what to retry.IdempotencySafe retries with Idempotency-Key, and dry_run previews.WebhooksEndpoints, the event catalog, and signature verification.SendingThe two-step preview/confirm flow and the send gates.
Where each section moved
| Was on this page | Now lives at |
|---|---|
| Before You Start | Quickstart, step 1 |
| Authentication | Concepts: Authentication |
| Scopes | Concepts: Authentication — the scope model |
| The Response Envelope | Concepts: Pagination — the list envelope |
| Pagination | Concepts: Pagination |
| Incremental Sync | Concepts: Pagination — incremental sync |
| Errors | Concepts: Errors |
| Idempotency | Concepts: Idempotency |
| Rate Limits | Concepts: Errors — rate limits |
| Versioning | Concepts: Authentication — API versioning |
| Verifying Webhooks | Concepts: Webhooks — verifying signatures |
| Next Steps | Quickstart — next steps |
Error code index
Every error this API returns carries a doc_url ending in #<code>that resolves to a row below. Each row links to the code's full entry — when it happens and what to do about it — on the errors page.