Skip to main content
GET
List mailbox threads

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Query Parameters

cursor
string

Pagination cursor — the next_cursor from the previous response.

limit
integer

Maximum results (default 50, max 100).

Required range: 1 <= x <= 100
q
string

Full-text search query across thread messages.

participant
string

Filter by participant email address or display name.

folder_id
string

Filter to threads with messages in this folder ID.

after
string

Filter to threads updated after this ISO 8601 timestamp.

before
string

Filter to threads updated before this ISO 8601 timestamp.

has_attachment
boolean

When true, only return threads with attachments.

is_unread
boolean

When true, only return threads with unread messages.

sort_direction
enum<string>

Sort direction.

Available options:
asc,
desc
mailbox_id
string

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Response

Thread list

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object[]
required
pagination
object
required