Skip to main content
GET
Fetch a campaign

Authorizations

Authorization
string
header
required

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

Path Parameters

campaignId
string<uuid>
required

The campaign id (a first-class campaigns row).

Response

The Campaign object.

A first-class campaigns row: org-global, homed in a workspace. Its queue is the set of sequences stamped with its id (one sequence per person). It owns no table: tableId is derived (informational) from the dominant table of its enrolled sequences.

object
string
required
Allowed value: "campaign"
id
string<uuid>
required
slug
string | null
required
name
string
required
status
enum<string>
required

The campaign's lifecycle state.

Available options:
draft,
active,
paused
workspaceId
string<uuid> | null
required
deprecated

Legacy home workspace; null for campaigns created from workspace-less chats.

tableId
string<uuid> | null
required

Derived leads table (dominant enrolled-sequence table); null for a shell campaign.

channels
object
required

Which channels the campaign sends on.

settings
object
required

Auto-cancel toggles (read-only on this object) + Auto Lead Refill (writable via PATCH /campaigns/{campaignId}).

brief
any | null
required

Agent-authored brief (audience prose + estimated size); null before drafting.

outOfLeads
boolean
required
haltedCount
integer
required

How many of an active campaign's people a disconnected sender stopped rather than their finishing. Reported for every active campaign, so it can be above zero while the campaign is still sending to everyone else; combine it with outOfLeads to read the campaign's end state. outOfLeads alone cannot tell a campaign that completed from one that was cut short, since both have nothing pending: outOfLeads with haltedCount above zero means the campaign ended early, and reconnecting the sender resumes those people while adding leads will not reach them. Zero for draft and paused campaigns.

Required range: x >= 0
createdAt
string<date-time>
required
updatedAt
string<date-time>
required