Skip to main content
GET
Retrieve a campaign

Authorizations

Authorization
string
header
required

A workspace API token. Create one in Settings → API. Send it as Authorization: Bearer sk_live_....

Path Parameters

campaign_id
string
required

Unique identifier for a campaign.

Pattern: ^camp_[0-9a-f]{32}$
Example:

"camp_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

Response

Successful Response

An outbound campaign.

created_at
string<date-time>
required
id
string
required

Unique identifier for a campaign.

Pattern: ^camp_[0-9a-f]{32}$
Example:

"camp_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

status
enum<string>
required
Available options:
scheduled,
running,
paused,
completed,
draft
updated_at
string<date-time>
required
instructions
string | null

How the AI should continue a conversation after a reply.

name
string | null
object
string
default:campaign
Allowed value: "campaign"