Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
{ "detail": [ { "loc": [ "<string>" ], "msg": "<string>", "type": "<string>" } ] }
Get detailed information about a specific campaign.
campaign_id
{ "id": 42, "name": "February Appointment Reminders", "description": "Reminder calls for February appointments", "campaign_type": "call", "status": "running", "assistant_id": 123, "assistant_name": "Appointment Bot", "welcome_message_template": "Hi {{name|title_case}}, this is {{assistant_name}} calling from {{company}}.", "agenda_template": "I'm calling to remind you about your appointment on {{appointment_date}}.", "end_call_message_template": "Thank you for your time, {{name}}. Have a great day!", "sms_message_template": null, "fallback_values": { "name": "there", "company": "our office" }, "variable_mappings": { "Phone": "phone_number", "Name": "name", "Appointment Date": "appointment_date" }, "available_variables": ["name", "phone_number", "appointment_date", "company"], "max_attempts": 3, "retry_delay_minutes": 60, "total_contacts": 250, "completed_contacts": 125, "failed_contacts": 10, "created_at": "2024-02-01T10:00:00Z", "updated_at": "2024-02-05T14:30:00Z", "last_import_file_name": "contacts_february.csv", "last_import_date": "2024-02-01T10:30:00Z", "last_import_row_count": 250 }
id
name
description
campaign_type
call
sms
mixed
status
assistant_id
assistant_name
welcome_message_template
agenda_template
end_call_message_template
sms_message_template
fallback_values
variable_mappings
available_variables
max_attempts
retry_delay_minutes
total_contacts
completed_contacts
failed_contacts
last_import_file_name
last_import_date
last_import_row_count
curl -X GET "https://api.burki.dev/api/v1/campaigns/42" \ -H "Authorization: Bearer YOUR_API_KEY"
import requests response = requests.get( "https://api.burki.dev/api/v1/campaigns/42", headers={"Authorization": "Bearer YOUR_API_KEY"} ) campaign = response.json() print(f"Campaign: {campaign['name']}") print(f"Status: {campaign['status']}") print(f"Progress: {campaign['completed_contacts']}/{campaign['total_contacts']}")
const response = await fetch("https://api.burki.dev/api/v1/campaigns/42", { headers: { "Authorization": "Bearer YOUR_API_KEY" } }); const campaign = await response.json(); console.log(`Campaign: ${campaign.name}`); console.log(`Status: ${campaign.status}`); console.log(`Progress: ${campaign.completed_contacts}/${campaign.total_contacts}`);
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
Successful Response