Skip to main content
GET
List Campaigns

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Query Parameters

organizationId
string

Optional organization scope for session-authenticated calls. OAuth client credentials resolve the organization from the token.

Maximum string length: 120
q
string
default:""

Search campaign name.

Maximum string length: 160
stage
enum<string>
default:all

all lists draft and running campaigns. Any other value lists that stage only.

Available options:
all,
draft,
approved,
running,
ending,
completed,
archived
offset
integer
default:0
Required range: 0 <= x <= 100000
limit
integer
default:20
Required range: 1 <= x <= 50

Response

Campaign page and stage summary.

campaigns
object[]
required
total
integer
required
Required range: 0 <= x <= 9007199254740991
hasMore
boolean
required
nextOffset
integer
required
Required range: 0 <= x <= 9007199254740991
summary
object
required
pagination
object
required