Email
Get Emails
Get a list of all emails for the user - only returns the metadata of the emails
GET
/
api
/
v1
/
email
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
valid_only
boolean
default: trueIf true
, only valid emails are returned
inbox_id
string | null
If provided, only emails from the specified inbox are returned
limit
integer
default: 100The maximum number of emails to return
Response
200 - application/json
id
string
requiredstatus
enum<string>
requiredAvailable 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
requiredAdditional information about the status of the email, e.g. why SPF failed
user_mark_status
boolean
default: falseIf true
, the email has been manually marked valid is considered valid even if the status is not valid
inbox_id
string
requiredto_addresses
object[]
requiredcc_addresses
object[]
requiredbcc_addresses
object[]
requiredreply_to_addresses
object[]
requiredfrom_address
object
requiredsubject
string
requireddate
string
requiredThe date the email was sent in UTC, ISO 8601 format
latest_webhook_log
object | null
required