Get campaign | Talkif Docs

{
  "allowedDays": [
    1
  ],
  "callWindows": [
    {
      "endTime": "17:00",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "startTime": "09:00",
      "dayOfWeek": 1
    }
  ],
  "concurrentCalls": 5,
  "createdAt": "2026-01-15T10:30:00Z",
  "earliestCallTime": "09:00",
  "flowId": "550e8400-e29b-41d4-a716-446655440000",
  "fromPhoneNumber": "+15551234567",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "latestCallTime": "17:00",
  "name": "January Outreach",
  "progress": {
    "activeCalls": 3,
    "completed": 250,
    "failed": 10,
    "noAnswer": 30,
    "notCalled": 5,
    "pending": 200,
    "percentage": 60,
    "skipped": 5,
    "total": 500
  },
  "providerId": "550e8400-e29b-41d4-a716-446655440000",
  "respectContactTimezone": true,
  "source": "user",
  "status": "draft",
  "completedAt": "2024-01-15T09:30:00Z",
  "description": "string",
  "endAt": "2024-01-15T09:30:00Z",
  "flowName": "Q1 Outreach Script",
  "flowVersion": "string",
  "metrics": null,
  "pauseReason": null,
  "pausedAt": "2024-01-15T09:30:00Z",
  "startAt": "2024-01-15T09:30:00Z",
  "startedAt": "2024-01-15T09:30:00Z"
}

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Path parameters

campaignIdstringRequiredformat: "uuid"

Campaign ID

Response

Campaign details

allowedDayslist of integers

DEPRECATED: Use call_windows instead. Allowed days of week

callWindowslist of objects

Call time windows in UTC

concurrentCallsinteger

Maximum number of simultaneous calls

createdAtdatetime

When the campaign was created

earliestCallTimestring

DEPRECATED: Use call_windows instead. Earliest call time in HH:MM

flowIdstringformat: "uuid"

Flow (conversation script) used for all calls

fromPhoneNumberstring

Caller ID phone number in E.164 format

idstringformat: "uuid"

Unique identifier for the campaign

latestCallTimestring

DEPRECATED: Use call_windows instead. Latest call time in HH:MM

namestring

Human-readable name for the campaign

progressobject

Contact processing progress counters

providerIdstringformat: "uuid"

VoIP provider used for routing

respectContactTimezoneboolean

Whether each contact's timezone is checked before calling

sourcestring

Driving subsystem: user (standard campaign) or meta_lead (auto-created envelope grouping Meta Lead Ads calls; fed on lead arrival, not by the scheduler)

statusenum

Current status of the campaign

completedAtdatetime or nullOptional

When the campaign finished processing all contacts

descriptionstring or nullOptional

Description of the campaign purpose

endAtdatetime or nullOptional

End time after which the campaign auto-pauses

flowNamestring or nullOptional

Display name of the flow. Null when the flow has since been deleted — the campaign still renders, it just has no name to show.

flowVersionstring or nullOptional

Pinned flow version at time of campaign creation

metricsobject or nullOptional

Aggregated call metrics for a campaign

pauseReasonenum or nullOptional

Reason why a campaign was paused

pausedAtdatetime or nullOptional

When the campaign was paused

startAtdatetime or nullOptional

Scheduled start time in UTC

startedAtdatetime or nullOptional

When the campaign was started

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error