Skip to main content
GET
/
campaign
/
{campaign_id}
Get Campaign Public
curl --request GET \
  --url https://api.staging.kathan.tech/campaign/{campaign_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-User-ID: <api-key>'
{
  "campaign": {
    "id": "<string>",
    "name": "<string>",
    "assistant_id": "<string>",
    "channel": "<string>",
    "phone_number_id": "<string>",
    "status": "<string>",
    "max_concurrency": 123,
    "retry_policy": {},
    "speech_settings": {
      "style": "neutral",
      "responsiveness": "balanced",
      "interruptions": "on",
      "emotions": "natural"
    },
    "caller_id_number": "<string>",
    "schedule_start_time": "<string>",
    "schedule_end_time": "<string>",
    "campaign_context": "<string>",
    "opening_message_template": "<string>",
    "use_returning_greeting": false,
    "use_short_term_summaries": false,
    "short_term_summaries_limit": 123,
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "counts": {},
  "calls": [
    {}
  ]
}

Authorizations

Authorization
string
header
required

API key authentication.

X-User-ID
string
header
required

Required user id for API key requests.

Path Parameters

campaign_id
string
required

Query Parameters

include_counts
boolean
default:true
include_calls
boolean
default:false

Response

Successful Response

campaign
CampaignPublic · object
required
counts
Counts · object
calls
Calls · object[] | null