GET
/
api
/
v1
/
email
/
outbound
Get Outbound Emails
curl --request GET \
  --url https://app.botmailroom.com/api/v1/email/outbound \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "status": "pending",
    "inbox_id": "<string>",
    "to_addresses": [
      {
        "address": "<string>",
        "name": "<string>"
      }
    ],
    "cc_addresses": [
      {
        "address": "<string>",
        "name": "<string>"
      }
    ],
    "bcc_addresses": [
      {
        "address": "<string>",
        "name": "<string>"
      }
    ],
    "reply_to_addresses": [
      {
        "address": "<string>",
        "name": "<string>"
      }
    ],
    "from_address": {
      "address": "<string>",
      "name": "<string>"
    },
    "subject": "<string>",
    "date": "<string>",
    "message_type": "forward",
    "open_and_click_tracking": true,
    "latest_event": {
      "event_type": "<string>",
      "date": "<string>"
    }
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
inbox_id
string<uuid> | null

If provided, only outbound emails from the specified inbox are returned

​
limit
integer
default:100

The maximum number of outbound emails to return

Response

Successful Response

​
id
string
required
​
status
enum<string>
required
Available options:
pending,
sent
​
inbox_id
string
required
​
to_addresses
EmailAddress · object[]
required
​
cc_addresses
EmailAddress · object[]
required
​
bcc_addresses
EmailAddress · object[]
required
​
reply_to_addresses
EmailAddress · object[]
required
​
from_address
object
required
​
subject
string
required
​
date
string
required

The date the email was sent in UTC, ISO 8601 format

​
message_type
enum<string>
required
Available options:
forward,
reply,
new
​
open_and_click_tracking
boolean
required

If true, open and click tracking was enabled for the email

​
latest_event
object | null
required