Retrieve a send
The outcome of a send already admitted. Costs no quota: an organization over its limit can still read what it already sent.
Every call needs a bearer token from an active API key. See Authentication. Create or manage keys from the API keys panel.
Path parameters
messageIdstringRequiredThe id POST /v1/email returned in its own results[].messageId.
Query parameters
None.
Headers
AuthorizationstringRequiredBearer ek_live_<key>.
Request attributes
None.
Response attributes
idstringRequiredThe same id as the path parameter.
addressstringRequiredThis addressee's own address.
statusstringRequiredclaimed, sent, suppressed, failed or unknown — see Notes.
deliveryStatusstring | nullRequirednull until the first webhook delivery. After that, deferred, delivered, rejected, bounced or complained — see Notes.
failureReasonstring | nullRequirednull unless status is failed, where it carries the provider's own reason.
createdAtstringRequiredWhen the send was admitted. Never null.
sentAtstring | nullRequirednull until the send attempt itself succeeded or failed.
deliveredAtstring | nullRequirednull until deliveryStatus reaches delivered.
Notes
statusis about the send attempt, not the delivery.claimedis the only value before the provider is ever called;sentandfaileddescribe whether that call succeeded;unknownis what an interruption between the claim and the provider’s answer leaves behind, after a bounded retry already had its chance — never a failed delivery on its own.deliveryStatusis a ladder that never moves backward, the same one the webhooks reference documents:deferred,delivered,rejected,bouncedandcomplained, in the order a late complaint can still arrive after a delivery already on record.- Costs no quota: an organization over its limit can still read what it already sent.
- Reading needs its own permission. This route requires
messages:read; sending requiresmessages:send. A key issued onlymessages:sendcan send but gets a403when retrieving a send, so issue the key with both permissions if it will do both.
Errors
| Status | Code | Cause |
|---|---|---|
| 403 | forbidden | The key was not issued messages:read. A key issued only messages:send gets this 403 when reading. |
| 404 | not_found | The message does not exist, or exists for another organization — the response never reveals which. |