GET
/
api
/
v1
/
email
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 | null

If provided, only emails from the specified inbox are returned

​
limit
integer
default:100

The maximum number of emails to return

Response

200
application/json

Successful Response

The response is of type object[].