Skip to main content
GET
List campaigns

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Query Parameters

pageSize
integer
default:25

Items per page.

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

The pagination.nextCursor of the page before. Later pages keep the first page's size.

Required string length: 1 - 200

Only campaigns whose name contains this text, in any case.

Required string length: 1 - 200
type
enum<string>

Only campaigns of this type.

Available options:
manual,
ai-generated
status
enum<string>

Only campaigns in this state: initializing (a draft), active, completed (running, with nothing left to send), stopped, paused_manual or initialization_failed.

Available options:
initializing,
active,
completed,
stopped,
paused_manual,
initialization_failed

Response

One page of the organization's campaigns.

data
object[]
required
pagination
object
required