GET
List campaigns

Authorizations

Authorization
string
header
required

Authorization: Bearer vg_live_<32 hex characters>. Keys are issued by Mergen admins and shown once. Missing or invalid key: 401 unauthorized. Suspended account: 403 tenant_suspended.

Query Parameters

status
enum<string>

Only campaigns with this status. draft (being set up; everything can change), created (launched; the configuration passed its blocking checks), testing (the dry run is working), tested (the dry run finished; see test_report), running, paused, completed (no record is left to call, or the end date passed) and canceled. A campaign moves from draft to created with launch, may be tested any number of times, then goes to running with start.

Available options:
draft,
created,
testing,
tested,
running,
paused,
completed,
canceled
agent_id
string

Only campaigns that use this agent.

Required string length: 1 - 128

Part of the campaign name (case is ignored).

Maximum string length: 100
limit
integer
default:50

Page size.

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

next_cursor of the previous page.

Minimum string length: 1

Response

A page of campaigns.

data
object[]
required
next_cursor
string | null
required