GET
/
api
/
v1
/
email

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_ids
string[] | null

If provided, only emails from the specified inboxes are returned

​
from_addresses
string[] | null

If provided, only emails from the specified addresses are returned

​
search_term
string | null

If provided, only emails containing the search term in the subject, body, or attachment filenames are returned

​
limit
integer
default:
100

The maximum number of emails to return

Response

200 - application/json
​
bcc_addresses
object[]
required
​
cc_addresses
object[]
required
​
date
string
required

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

​
from_address
object
required
​
id
string
required
​
inbox_id
string
required
​
latest_webhook_log
object | null
required
​
reply_to_addresses
object[]
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

​
subject
string
required
​
to_addresses
object[]
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

Send EmailGet Email Content