Retrieve a transactional email
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://api.azimea.com/v1/sending/emails/example"), Headers = { { "Authorization", "Bearer <token>" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://api.azimea.com/v1/sending/emails/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.azimea.com/v1/sending/emails/example \ --header 'Authorization: Bearer <token>'Returns the submission and each recipient’s current status and reason. Use the id returned by POST /sending/emails. The account’s API key needs emails:read. BCC addresses are visible only to the sending account, never in email headers.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”The submission and its recipient deliveries
object
true when the call worked, false when errors say why it did not.
The answer itself; null when the call failed.
object
The submission id. Use it to retrieve all recipient statuses. For a single recipient it is also the delivery id.
The common delivery status, or Mixed when recipients have different statuses. Inspect recipients for the individual outcomes.
The common reason when all recipients share one; null otherwise. Inspect recipients[].reason for individual problems.
All recipient deliveries, including suppressed ones. Each has independent status, retries, tracking and quota usage.
object
The delivery id for this recipient. Matches message_id in delivery webhooks.
The normalized recipient address. Empty after retention removes personal data.
The optional recipient display name.
Whether the recipient was requested as To, Cc or Bcc.
This recipient’s current delivery status. Queued and Sent do not mean Delivered.
The reason for suppression, waiting or failure, when present.
Requested UTC schedule, or null for immediate sends. Queued also covers a future schedule.
The template used at acceptance, if any.
Caller correlation data; removed when retention erases message content.
object
Caller labels; removed when retention erases message content.
object
An internal result number. Rely on the HTTP status code instead.
What went wrong, one entry per problem; empty when the call worked.
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
The same problems grouped by the request field they belong to; null when none is tied to a field.
object
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
Example
{ "isSuccess": true, "value": { "id": "01a10900-0000-7000-8000-000000000301", "status": "Delivered", "reason": null, "recipients": [ { "id": "01a10900-0000-7000-8000-000000000301", "email": "emma@example.com", "name": "Emma", "kind": "To", "status": "Delivered", "reason": null } ], "sendAt": null, "templateId": null, "metadata": {}, "tags": {} }, "status": 0, "errors": [], "fieldErrors": null}Unauthorized
Forbidden
The email does not exist in this account
object
true when the call worked, false when errors say why it did not.
The answer itself; null when the call failed.
An internal result number. Rely on the HTTP status code instead.
What went wrong, one entry per problem; empty when the call worked.
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
The same problems grouped by the request field they belong to; null when none is tied to a field.
object
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
Examplegenerated
{ "isSuccess": true, "value": "example", "status": 1, "errors": [ { "code": "example", "message": "example", "params": { "additionalProperty": "example" } } ], "fieldErrors": { "additionalProperty": [ { "code": "example", "message": "example", "params": { "additionalProperty": "example" } } ] }}Too many requests for this key. Wait the number of seconds in the Retry-After header, then send again.