Skip to main content
GET
List emails

Authorizations

x-api-key
string
header
required

API key (sk-proj-…) from Settings → API Keys. Required for sold API calls outside the Mermail console.

Path Parameters

mailboxId
string
required

Mailbox public_id (UUID), hosted alias id, or current email

Query Parameters

folder
string

Folder id

thread_id
string

Filter by thread id

category
enum<string>

Email category

Available options:
customer_support,
technical,
partnership,
other
custom_label
string

Custom label slug

is_starred
string

true/1 or false/0

is_read
string

true/1 or false/0

threaded
string

Set to true/1 to aggregate by thread

page
integer

Page number (≥1)

Required range: x >= 1
limit
integer

Page size (1–100, default 25)

Required range: 1 <= x <= 100
sortColumn
enum<string>

Sort column

Available options:
id,
subject,
sender,
recipient,
date,
read,
starred
sortDirection
string

ASC for ascending; otherwise descending

Response

Email list

emails
object[]
totalCount
integer