Skip to main content
GET
List Campaigns

Authorizations

X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. Keys are scoped to your organization hierarchy.

Query Parameters

limit
integer
default:50

Rows per page, 1-200.

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

Opaque cursor from the previous page's next_cursor.

Maximum string length: 4096
status
enum<string>
Available options:
draft,
awaiting_test,
awaiting_approval,
ready,
scheduled,
compiling,
sending,
paused,
completed,
deleted

Case-insensitive substring match.

Maximum string length: 255

Response

A page of campaigns.

success
boolean
required
data
object
required