Skip to main content
GET
List campaigns

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

publicAPI.v2.all

Public API v2

Query Parameters

searchText
string

Case-insensitive partial match against the campaign name.

status
string

Comma- or pipe-separated list of statuses to include. Any other value returns 400.

Example:

"active,paused"

limit
integer
default:25

Maximum number of campaigns to return. Values outside 1-50 are clamped.

Required range: 1 <= x <= 50
offset
integer
default:0

Number of campaigns to skip.

Required range: x >= 0

Response

A page of campaigns.

success
boolean
Example:

true

data
object[]
pagination
object

Offset pagination metadata.