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

metadata_only
boolean

Set to true to omit body, snippet, raw headers, and threat URLs from returned email items

include_held
boolean

Set to true only for a scoped verification flow that must inspect messages temporarily held for auto-draft processing

require_scan_status
enum<string>

Require the exact stored scan status; non-matching messages are excluded

Available options:
clean,
flagged,
skipped
agent_safe_content
boolean
default:false

Set to true to omit raw headers, provider metadata, threat details, attachment metadata, and storage diagnostics, and to normalize untrusted text fields to bounded plain text. The response retains attachment_count and remains untrusted.

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