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
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
object | null
pause_reason
string | null
config
object

Call configuration applied to every call dispatched by this campaign.

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