Skip to main content
GET
List a campaign's deliveries

Authorizations

Authorization
string
header
required

Your project's secret key (pk_…, without the pub segment). Server-side only — never ship it to a browser. Get it from Settings → Projects in the dashboard.

Path Parameters

id
string
required
Maximum string length: 128

Query Parameters

state
enum<string>

Only return deliveries in this state. frequency_capped is a permanent campaign-email skip caused by the project recipient's rolling 24-hour limit.

Available options:
queued,
sending,
retryable,
frequency_capped,
sent,
delivered,
shown,
opened,
clicked,
dismissed,
bounced,
complained,
unsubscribed,
failed,
converted
page
integer
default:1

Page number.

Required range: x >= 1
perPage
integer
default:50

Items per page (max 100).

Required range: 1 <= x <= 100

Response

The campaign's deliveries.

deliveries
object[]
required
total
integer
required
Example:

412

page
integer
required
Example:

1

pageCount
integer
required
Example:

9