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>
required
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 + auto-refill, surfaced read-only.

brief
any | null
required

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

outOfLeads
boolean
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required