Skip to main content
GET
List Campaigns

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
enum<string> | null

Campaign status values.

Available options:
draft,
launching,
scheduled,
active,
draining,
paused,
completed,
failed
search
string | null

Search by campaign name

page
integer
default:1

Page number

Required range: x >= 1
page_size
integer
default:20

Items per page

Required range: 1 <= x <= 100

Response

Successful Response

Response model for campaign list.

campaigns
CampaignResponse · object[]
required

List of campaigns

total
integer
required

Total number of campaigns

page
integer
required

Current page number

page_size
integer
required

Items per page