Skip to main content
GET
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Query Parameters

label
string

Filter by label

direction
string

inbound or outbound

starting_after
string

Cursor for pagination — the ID of the last item in the previous page

limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
include_spam
boolean
default:false

Include mail labeled spam. Held mail is never returned.

include_trash
boolean
default:false

Include mail labeled trash.

labels
string[]

Only items carrying every one of these labels, e.g. unread.

before
string<date-time>

Only items whose latest activity is before this time (ISO 8601).

after
string<date-time>

Only items whose latest activity is after this time (ISO 8601).

ascending
boolean
default:false

Oldest first instead of newest first.

senders
string[]

Substring match on sender name or address. Repeat to require every value.

recipients
string[]

Substring match on recipient name or address. Repeat to require every value.

subject
string[]

Substring match on the subject. Repeat to require every value.

Response

Messages

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required
url
string