Skip to main content
GET
/
v1
/
emails
/
{id}
cURL
curl --request GET \
  --url https://api.transmit.dev/v1/emails/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "from": "<string>",
  "to": [
    "jsmith@example.com"
  ],
  "subject": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "sent_at": "2023-11-07T05:31:56Z",
  "delivered_at": "2023-11-07T05:31:56Z",
  "opened_at": "2023-11-07T05:31:56Z",
  "clicked_at": "2023-11-07T05:31:56Z",
  "open_count": 123,
  "click_count": 123,
  "events": [
    {
      "type": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "data": {
        "user_agent": "<string>",
        "ip_address": "<string>",
        "location": "<string>",
        "link": "<string>"
      }
    }
  ],
  "html": "<string>",
  "text": "<string>"
}

Authorizations

ā€‹
Authorization
string
header
required

Enter your API key with 'tx_' prefix. Get your API key from the dashboard.

Path Parameters

ā€‹
id
string
required

Response

Email details retrieved successfully

ā€‹
id
string
required

Email ID

ā€‹
from
string
required

Sender address. Supports optional display name (e.g. 'Sender Name sender@example.com').

Minimum string length: 1
ā€‹
to
string<email>[]
required

Recipient email addresses

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
ā€‹
subject
string
required

Email subject

ā€‹
status
string
required

Email status

ā€‹
created_at
string<date-time>
required

Creation timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
ā€‹
sent_at
string<date-time> | null
required

Sent timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
ā€‹
delivered_at
string<date-time> | null
required

Delivery timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
ā€‹
opened_at
string<date-time> | null
required

First open timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
ā€‹
clicked_at
string<date-time> | null
required

First click timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
ā€‹
open_count
number
required

Total open count

ā€‹
click_count
number
required

Total click count

ā€‹
events
object[]
required

Email events

ā€‹
html
string

HTML content

ā€‹
text
string

Plain text content