Skip to main content
GET
List campaigns

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.

Query Parameters

status
enum<string>

Only return campaigns with this effective status. scheduled and expired derive from the delivery window; running excludes campaigns whose window hasn't opened or has ended, and paused excludes those whose window has ended.

Available options:
draft,
scheduled,
running,
paused,
expired,
ended
q
string

Case-insensitive substring match on the campaign name.

Maximum string length: 200
page
integer
default:1

Page number.

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

Items per page (max 100).

Required range: 1 <= x <= 100

Response

The project's campaigns.

campaigns
object[]
required
Maximum array length: 100
total
integer
required
Example:

42

page
integer
required
Example:

1

pageCount
integer
required
Example:

1

evaluatedAt
integer
required

Epoch milliseconds. The single instant used for filtering and for every effectiveStatus in this response.