Skip to main content
GET
/
campaign
List Campaigns Public
curl --request GET \
  --url https://api.staging.kathan.tech/campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'X-User-ID: <api-key>'
[
  {
    "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>"
  }
]

Authorizations

Authorization
string
header
required

API key authentication.

X-User-ID
string
header
required

Required user id for API key requests.

Query Parameters

limit
integer
default:50
offset
integer
default:0

Response

Successful Response

id
string
required
name
string
required
assistant_id
string
required
channel
string
required
phone_number_id
string
required
status
string
required
max_concurrency
integer
required
retry_policy
Retry Policy · object
required
speech_settings
SpeechSettings · object
required
caller_id_number
string | null
schedule_start_time
string | null
schedule_end_time
string | null
campaign_context
string | null
opening_message_template
string | null
use_returning_greeting
boolean
default:false
use_short_term_summaries
boolean
default:false
short_term_summaries_limit
integer | null
created_at
string | null
updated_at
string | null