Skip to Content
API ReferenceOverview

API Reference

SDKs

LanguagePackageInstall
Node.js / TypeScriptretransmit.devnpm install retransmit.dev

The SDK wraps every endpoint below with typed methods (emails.send, emails.get, batch.send, batch.get) and returns { data, error } instead of throwing on API errors. Each endpoint page shows the SDK call alongside the raw HTTP request. Other languages can call the HTTP API directly.

Base URL

EnvironmentBase URL
Productionhttps://api.retransmit.dev
Local developmenthttp://localhost:3002

All endpoints are versioned under /v1.

Authentication

Every request must include your API key as a Bearer token:

Authorization: Bearer rt_xxxxxxxxxxxxxxxx

Keys are created in the dashboard and shown once. A missing, malformed, or revoked key returns 401 unauthorized:

{ "error": { "code": "unauthorized", "message": "Provide your API key as `Authorization: Bearer rt_...`" } }

Response format

Responses are JSON. Errors always have the shape:

{ "error": { "code": "some_error_code", "message": "Human-readable explanation" } }

See Errors for the full list of codes.

Endpoints

MethodPathDescription
POST/v1/emailsQueue a transactional email
POST/v1/emails/batchQueue up to 10,000 emails in one request
GET/v1/emails/:idRetrieve an email and its event history
GET/v1/emails/batch/:idBatch progress: counts per status
GET/healthHealth check (no auth required)

Asynchronous sending

Submitting an email returns 202 Accepted immediately with status queued. A worker drains the queue at the platform’s provider rate, retries transient failures with exponential backoff, and dead-letters an email as failed only after all retries are exhausted. Track outcomes by polling Get Email / Get Batch, or push-based via Webhooks.

Last updated on