Sign in
Messages

List Messages

get/api/v1/mail/mailboxes/{email_address}/messages

Path parameters

email_addressstring required

Query parameters

cursorstring nullable
limitinteger
direction'inbound' | 'outbound'
folder'inbox' | 'spam' | 'blocked' | 'archive'

Filter by thread folder. Omit to list all.

start_datetimestring nullable

Filter created_at >= this date/datetime. Bare date => whole day in tz.

Filter created_at >= this date/datetime. Bare date => whole day in tz.

end_datetimestring nullable

Filter created_at <= this date/datetime. Bare date => whole day inclusive.

Filter created_at <= this date/datetime. Bare date => whole day inclusive.

tzstring nullable

IANA zone (e.g. America/New_York) for zone-less values; default UTC.

IANA zone (e.g. America/New_York) for zone-less values; default UTC.

Response

Successful Response

next_cursorstring nullable
has_moreboolean

Changes

No recorded changes to this endpoint across all 1 revision of this API.