Skip to main content
GET
List campaigns

Authorizations

Authorization
string
header
required

Send either an API token or an OAuth access token as Authorization: Bearer <token>. See the Authentication page for details.

Headers

Privy-Account-Id
string

Target a subaccount instead of the main connected account. Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself.

Query Parameters

page
integer
default:1

Page number (starts at 1).

Required range: x >= 1
per_page
integer
default:40

Number of results per page. Values outside 10–100 are clamped to the nearest bound.

Required range: 10 <= x <= 100
type
enum<string>

Pass flows to list the messages your flows send instead of newsletters.

Available options:
flows
channel
enum<string>

Filter by message channel. Works for both newsletters and flow campaigns.

Available options:
email,
sms
status
enum<string>

Filter newsletters by send lifecycle. Not supported with type=flows (flow campaigns have no send lifecycle of their own — their live/draft state belongs to the parent flow, via GET /v1/flows → status) — combining them returns a 422.

Available options:
draft,
scheduled,
preparing,
awaiting_winner,
sending,
sent,
partially_sent,
unsent,
canceled

Response

A paginated list of message campaigns.

data
object[]
pagination
object