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

limit
integer
default:25

How many items to return, from 1 to 100. The default is 25.

Required range: 1 <= x <= 100
Example:

25

cursor
string

The next_cursor from the previous page. Send it with the same filters as that request.

Example:

"MTc1OTgyMDQwMDAwMC5hYmMuMTIzNDU2Nzg5MGFi"

brand_id
string

Return only the campaigns of this brand. A brand ID that your API key cannot read returns 404.

Example:

"brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7"

status
enum<string>

pending_payment: the budget is not paid yet. ready_to_launch: the budget is paid and the campaign is not live yet. active: the campaign is live and clips earn. paused: the campaign stopped paying for new views. ended: the campaign is over.

Available options:
pending_payment,
ready_to_launch,
active,
paused,
ended
Example:

"active"

Response

Successful response

data
object[]
required
next_cursor
string | null
required

Send this as cursor to get the next page. It is null on the last page.