Emails
Retrieve and list sent email records with delivery status.
Retrieve individual emails and list your project's outbound email history. Email IDs come from the response to POST /v1/send or POST /emails/batch.
Email object
{
"id": "3f2a91b0-4c2a-4e8d-b0e0-abc123def456",
"subject": "Welcome to Acme",
"from": "hello@yourdomain.com",
"fromName": "Acme",
"status": "DELIVERED",
"opens": 2,
"clicks": 1,
"sentAt": "2026-01-15T10:30:00.000Z",
"deliveredAt": "2026-01-15T10:30:01.000Z",
"openedAt": "2026-01-15T11:00:00.000Z",
"clickedAt": "2026-01-15T11:05:00.000Z",
"bouncedAt": null,
"complainedAt": null,
"contact": { "id": "con_01HV3K...", "email": "jane@example.com" },
"template": { "id": "tmpl_01HV3K...", "subject": "Welcome to Acme" },
"createdAt": "2026-01-15T10:29:59.000Z"
}Status values
| Status | Description |
|---|---|
PENDING | Queued for delivery |
SENT | Accepted by the mail server |
DELIVERED | Delivery confirmed |
OPENED | Recipient opened the email |
CLICKED | Recipient clicked a link |
BOUNCED | Delivery failed permanently |
COMPLAINED | Marked as spam |
FAILED | Internal delivery error |
Retrieve an email
Returns the email record including full delivery status, open/click timestamps, and any associated events.
Response
{
"email": {
"id": "3f2a91b0-...",
"subject": "Welcome to Acme",
"status": "DELIVERED",
"sentAt": "2026-01-15T10:30:00.000Z",
"deliveredAt": "2026-01-15T10:30:01.000Z",
"openedAt": "2026-01-15T11:00:00.000Z",
"opens": 2,
"clicks": 1,
"contact": { "id": "con_01HV...", "email": "jane@example.com" },
"events": [
{ "name": "delivered", "data": {}, "createdAt": "2026-01-15T10:30:01.000Z" },
{ "name": "opened", "data": {}, "createdAt": "2026-01-15T11:00:00.000Z" }
]
}
}List emails
Returns a paginated list of outbound emails.
| Parameter | Description |
|---|---|
status | Filter by status: PENDING, SENT, DELIVERED, OPENED, CLICKED, BOUNCED, COMPLAINED, FAILED |
source | Filter by source: TRANSACTIONAL, CAMPAIGN, WORKFLOW |
search | Search by recipient email address |
startDate / endDate | Date range filter (ISO 8601) |
cursor | Cursor for next page |
Response
{
"data": [
{
"id": "3f2a91b0-...",
"subject": "Welcome to Acme",
"status": "DELIVERED",
"sentAt": "2026-01-15T10:30:00.000Z",
"contact": { "id": "con_01HV...", "email": "jane@example.com" }
}
],
"nextCursor": "eyJpZCI6IjNmMm..."
}