Sign in
Emails

Get an email by ID

get/emails/{id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/emails/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Email ID (UUID)

Response

Email details

bcc_addressesstring[] nullable
cc_addressesstring[] nullable
click_countinteger required

Number of times links in the email were clicked

created_atstring required
domain_idinteger nullable
error_messagestring nullable
first_clicked_atstring nullable

When a link was first clicked

first_opened_atstring nullable

When the email was first opened

from_addressstring required
from_namestring nullable
headersobject nullable
html_bodystring nullable
idstring required
open_countinteger required

Number of times the email was opened

project_idinteger nullable
provider_message_idstring nullable
reply_tostring nullable
sent_atstring nullable
statusstring required
subjectstring required
tagsstring[] nullable
text_bodystring nullable
to_addressesstring[] required
track_clicksboolean required

Whether click tracking is enabled

track_opensboolean required

Whether open tracking is enabled

tracked_html_bodystring nullable

The final HTML sent to the provider (with tracking pixel and rewritten links)

Example response

{
  "created_at": "2025-12-03T10:30:00Z",
  "from_address": "hello@updates.example.com",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "sent"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.