Skip to main content
GET
Get campaign details

Authorizations

Authorization
string
header
required

Use Authorization: Bearer tc_live_xxxxx

Path Parameters

campaign_id
string<uuid>
required

Campaign UUID

Response

Campaign details

Campaign record. Returned by GET /v1/campaigns and GET /v1/campaigns/{campaign_id}. Projected to this documented field set; additional internal columns are never included.

id
string<uuid>
account_id
string<uuid>
name
string
description
string | null
status
enum<string>
Available options:
draft,
scheduled,
running,
paused,
completed,
failed,
cancelled
direction
enum<string>

outbound campaigns are dialled; inbound campaigns answer calls on a phone number and are never dialled. Live inbound is status: running plus a phone-number attach. A draft inbound campaign with a number attached does not answer.

Available options:
outbound,
inbound
inbound_phone_numbers
object[]

Live inbound routes for this campaign: phone numbers with inbound_enabled true, status active or verified, and inbound_campaign_id set to this campaign. Empty when none. Full inbound config stays on GET /v1/phone-numbers.

timezone
string | null

IANA timezone name used to interpret dispatch hours and schedule_time.

schedule_time
string<date-time> | null
dispatch_hours_start
string | null

Local time of day dispatch may begin, HH:MM:SS.

dispatch_hours_end
string | null

Local time of day dispatch must stop, HH:MM:SS.

dispatch_weekdays
integer[]

Weekdays dispatch is allowed, 1=Monday through 7=Sunday.

Required range: 1 <= x <= 7
dispatch_hours_overrides
object | null

Per-weekday overrides of the default dispatch hours.

max_attempts_per_lead
integer
max_parallel_calls
integer | null
conversion_outcomes
string[] | null
outcome_mapping

Optional mapping of raw call outcomes to normalized dispositions. The gateway currently returns the jsonb column default, an empty array [], for every campaign; a configured mapping is an object. Clients should accept either an array or an object shape (and null).

pause_reason
string | null
lead_list_ids
string<uuid>[]

Ids of the lead lists attached to this campaign.

config
object

Call configuration applied to every call dispatched by this campaign.

created_at
string<date-time>
updated_at
string<date-time> | null