Skip to main content
GET
List campaigns

Authorizations

Authorization
string
header
required

A workspace API key.

Query Parameters

status
enum<string>
default:all

Filter by lifecycle state. all returns every campaign.

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

How many campaigns to return. Between 1 and 100; defaults to 50.

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

Opaque continuation from nextCursor, bound to this user, workspace, and status filter.

Maximum string length: 1024

Response

Success.

success
boolean
required
campaigns
object[]
required
hasMore
boolean
required
nextCursor
string | null
required
{key}
any