Skip to main content
GET
List campaigns

Authorizations

Authorization
string
header
required

A workspace API token (sk_live_...) or an OAuth access token (oat_live_...). Create workspace tokens in Settings > API. Send either as Authorization: Bearer <token>.

Query Parameters

status
enum<string> | null

Restrict to one campaign status. Where a campaign is in its lifecycle.

A campaign whose audience is still being assembled reads as draft until it is ready.

Available options:
draft,
scheduled,
running,
paused,
completed
limit
integer
default:50

Items per page (max 200).

Required range: 1 <= x <= 200
cursor
string | null

Opaque cursor from a previous response's links.next.

Response

Successful Response

A page of campaigns.

data
Campaign · object[]
required
meta
PageMeta · object
required