GET
/
api
/
v1
/
email
Get Emails
curl --request GET \
  --url https://app.botmailroom.com/api/v1/email \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "status": "valid",
    "status_message": "<string>",
    "user_mark_status": false,
    "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>",
    "latest_webhook_log": {
      "id": "<string>",
      "status_code": 123,
      "response_body": "<string>",
      "created_at": "<string>"
    }
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
valid_only
boolean
default:true

If true, only valid emails are returned

​
inbox_id
string<uuid> | null

If provided, only emails from the specified inbox are returned

​
limit
integer
default:100

The maximum number of emails to return

Response

Successful Response

​
id
string
required
​
status
enum<string>
required
Available options:
valid,
invalid_to_address,
not_allowed_from_address,
not_allowed_cc_address,
not_allowed_bcc_address,
blocked_from_address,
spf_fail,
dkim_fail,
dmarc_fail
​
status_message
string | null
required

Additional information about the status of the email, e.g. why SPF failed

​
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

​
latest_webhook_log
object | null
required
​
user_mark_status
boolean
default:false

If true, the email has been manually marked valid is considered valid even if the status is not valid