GET
/
api
/
v1
/
email
/
{email_id}
curl --request GET \
  --url https://app.botmailroom.com/api/v1/email/{email_id} \
  --header 'Authorization: Bearer <token>'
{
  "plain_text": "<string>",
  "html": "<string>",
  "alternative_content": false,
  "attachments": [
    {
      "filename": "<string>",
      "content_type": "<string>",
      "content_encoding": "<string>",
      "content_id": "<string>",
      "id": "<string>"
    }
  ],
  "to_addresses": [
    {
      "address": "<string>",
      "name": "<string>"
    }
  ],
  "from_address": {
    "address": "<string>",
    "name": "<string>"
  },
  "cc_addresses": [
    {
      "address": "<string>",
      "name": "<string>"
    }
  ],
  "bcc_addresses": [
    {
      "address": "<string>",
      "name": "<string>"
    }
  ],
  "reply_to_addresses": [
    {
      "address": "<string>",
      "name": "<string>"
    }
  ],
  "subject": "<string>",
  "date": "<string>",
  "in_reply_to_id": "<string>",
  "references": [
    "<string>"
  ],
  "message_id": "<string>",
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
email_id
string
required

Response

200
application/json

Successful Response

​
to_addresses
object[]
required
​
from_address
object
required
​
cc_addresses
object[]
required
​
bcc_addresses
object[]
required
​
reply_to_addresses
object[]
required
​
subject
string
required
​
date
string
required
​
in_reply_to_id
string | null
required

The id of the email that this email is a reply to, as passed in the In-Reply-To header. If null, this email is not a reply to another email

​
references
string[] | null
required

A list of ids of emails that precede this email in a conversation thread, as passed in the References header. If null, this email is not part of a conversation thread

​
message_id
string | null
required

The message id of the email, as passed in the Message-ID header. This is not the same as the BotMailRoom email id but rather is an id used by email clients and servers to identify emails

​
id
string
required
​
plain_text
string | null

The plain text content of the email. Can be null if the email is only available in html

​
html
string | null

The html content of the email. Can be null if the email is only available in plain text

​
alternative_content
boolean
default:false

If true, html and plain_text are alternative representations of the same content

​
attachments
object[]

Metadata about the attachments of the email, does not include the actual attachment data. Use the relevant get attachment endpoints to retrieve the attachment data