Skip to main content
GET
List emails

Authorizations

X-API-KEY
string
header
required

Your access token, from your dashboard under API keys.

Query Parameters

account_id
string

Emails of this account only. Without it, emails of all accounts.

folder
string

Emails in this folder: a fld_… id, the provider's folder id, or a role (INBOX, SENT, DRAFTS, TRASH, SPAM, ARCHIVE).

role
enum<string>

Emails whose main role is this one. An email you sent yourself (in Inbox and Sent) matches only its main role.

Available options:
INBOX,
SENT,
DRAFTS,
TRASH,
SPAM,
ARCHIVE,
ALL,
IMPORTANT,
STARRED,
UNKNOWN
from
string<email>

Sender's email address (exact, case-insensitive).

to
string<email>

A recipient's address, in to, cc or bcc.

any_email
string<email>

The sender or any recipient: every email exchanged with one person.

thread_id
string

All emails of one conversation.

unread
boolean

true: unread only. false: read only.

starred
boolean

true: flagged (IMAP) or starred (Gmail) only.

has_attachments
boolean

true: emails with at least one attachment (inline images count).

subject
string

Subject contains this text (case-insensitive).

after
string<date-time>

Emails dated after this time (ISO 8601).

before
string<date-time>

Emails dated before this time (ISO 8601).

include_headers
boolean
default:false

Add every header (headers) to each email.

limit
integer
default:50

How many items per page, 1 to 250.

Required range: 1 <= x <= 250
cursor
string

The cursor from the previous page. Leave it out for the first page.

Response

The emails.

object
string
Allowed value: "Emails"
data
object[]
has_more
boolean
cursor
string | null

Pass it back for the next page. null on the last page.