Skip to main content
GET
List campaign messages

Authorizations

Authorization
string
header
required

Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.

Path Parameters

campaignId
integer
required

Numeric campaign identifier.

Example:

24

Query Parameters

limit
integer
default:25
Required range: 1 <= x <= 100
bounce_category
enum<string>

Diagnostic cause identifier. The UI labels unknown as Unclassified and dns_routing_error as DNS or routing error. Unknown is the fallback when evidence does not establish a cause.

Available options:
invalid_recipient,
mailbox_unavailable,
mailbox_full,
authentication_failed,
policy_blocked,
spam_rejected,
reputation_blocked,
rate_limited,
content_rejected,
dns_routing_error,
transport_error,
unknown
segment
enum<string>
default:all
Available options:
all,
sent,
opened,
bounced
sort
enum<string>
default:send_at
Available options:
send_at
direction
enum<string>
default:desc
Available options:
asc,
desc
cursor
string
Maximum string length: 2048

Response

A bounded page of campaign messages.

results
object[]
required
next
string | null
required
prev
string | null
required
limit
integer
required