Skip to main content
GET
Get Campaign

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace. Refused with 404 (Workspace not found.) when the id is unknown, is not one of your customers, or is not an org_… id; 410 when that customer was deleted (restore it with POST /customers/{id}/restore until it is erased); 403 when the key belongs to one customer workspace (it cannot act as another); 400 when your workspace is not a developer workspace. /customers/* and GET /customers/usage are your own workspace's and refuse the header with 400: call them without it.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Path Parameters

id
string
required

The campaign's id (cmp_…), as Create Campaign and List Campaigns return it.

Response

The campaign.

A WhatsApp broadcast or a calling campaign, with its results.

id
string
required

The campaign's id.

Example:

"cmp_9a3b7c21-4d5e-4f60-8a1b-2c3d4e5f6a7b"

agent
string
required

A calling campaign: the agent that makes the calls. A broadcast: the agent that answers replies to it.

Example:

"ag_5c4a5f93-2b1e-4c0a-9d3f-7e8a1b2c3d4e"

name
string
required

The campaign's name, as the console lists it.

kind
enum<string>
required

whatsapp for a broadcast, voice for a calling campaign.

Available options:
whatsapp,
voice
status
enum<string>
required

draft until launched (a scheduled campaign stays a draft until scheduledAt), sending while it runs, paused when stopped for now, then sent, failed (it could not run; see lastError) or cancelled.

Available options:
draft,
sending,
paused,
sent,
failed,
cancelled
template
string | null
required

A broadcast's template name. null on a calling campaign.

purpose
string | null
required

A calling campaign's opening line: the sentence the agent opens each call with, copied from the agent when the campaign was created (editing the agent later does not change it). null on a broadcast.

counts
object
required

How far the campaign has got, person by person.

scheduledAt
string<date-time> | null
required

When a scheduled campaign starts itself. null when it is started by hand.

startedAt
string<date-time> | null
required

When it started sending. null while a draft.

finishedAt
string<date-time> | null
required

When it finished or was cancelled. null while it can still send.

createdAt
string<date-time>
required

When it was created.

lastError
string | null
required

Why the campaign last stopped or failed, when it did. Cleared when it is launched or resumed.