Skip to main content
GET
/
campaigns
/
{campaignId}
Fetch a campaign
curl --request GET \
  --url https://origami.chat/api/v2/campaigns/{campaignId} \
  --header 'Authorization: Bearer <token>'
{
  "object": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "name": "<string>",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "channels": {
    "email": true,
    "linkedin": true
  },
  "settings": {
    "blockActiveDuplicates": true,
    "blockPriorContacts": true,
    "autoTopUpEnabled": true
  },
  "brief": "<unknown>",
  "outOfLeads": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

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