Skip to main content
GET
/
api
/
v1
/
campaigns
/
{campaign_id}
/
contacts
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.burki.dev/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a paginated list of contacts for a specific campaign, with optional status filtering.

​
Path Parameters

  • campaign_id (integer, required): The unique identifier of the campaign

​
Query Parameters

  • page (integer, optional, default: 1): Page number for pagination
  • per_page (integer, optional, default: 50, max: 1000): Results per page
  • status (string, optional): Filter by contact status

​
Contact Statuses

StatusDescription
pendingWaiting to be contacted
in_progressCurrently being contacted
completedSuccessfully contacted
failedContact attempt failed
skippedSkipped (DNC, re-execute filter, etc.)
no_answerCall not answered
busyLine was busy
voicemailReached voicemail

​
Response

Response
{
  "contacts": [
    {
      "id": 101,
      "phone_number": "+15551234567",
      "contact_data": {
        "company": "Acme Corp",
        "source": "csv_import",
        "variable_values": {
          "name": "John Smith",
          "appointment_date": "2024-02-15"
        },
        "custom_fields": {
          "customer_id": "CUST001"
        }
      },
      "status": "completed",
      "attempts": 1,
      "created_at": "2024-02-01T10:30:00Z",
      "last_attempt_at": "2024-02-01T11:15:00Z"
    },
    {
      "id": 102,
      "phone_number": "+15559876543",
      "contact_data": {
        "company": "Tech Inc",
        "source": "csv_import",
        "variable_values": {
          "name": "Jane Doe",
          "appointment_date": "2024-02-16"
        }
      },
      "status": "pending",
      "attempts": 0,
      "created_at": "2024-02-01T10:30:00Z",
      "last_attempt_at": null
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total_items": 250,
    "total_pages": 5,
    "has_next": true,
    "has_prev": false
  }
}

​
Response Fields

FieldDescription
idUnique contact identifier
phone_numberContact’s phone number (E.164 format)
contact_dataContact metadata and custom fields
contact_data.variable_valuesValues available for templates
contact_data.custom_fieldsAdditional imported fields
statusCurrent contact status
attemptsNumber of contact attempts
created_atWhen contact was added
last_attempt_atLast contact attempt timestamp

​
Example Code

cURL
# Get all contacts
curl -X GET "https://api.burki.dev/api/v1/campaigns/42/contacts" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Get failed contacts only
curl -X GET "https://api.burki.dev/api/v1/campaigns/42/contacts?status=failed" \
  -H "Authorization: Bearer YOUR_API_KEY"
Python
import requests

# Get all contacts with pagination
response = requests.get(
    "https://api.burki.dev/api/v1/campaigns/42/contacts",
    params={"page": 1, "per_page": 100},
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)

data = response.json()
for contact in data["contacts"]:
    print(f"{contact['phone_number']}: {contact['status']}")

print(f"Page {data['pagination']['page']} of {data['pagination']['total_pages']}")
JavaScript
// Get pending contacts
const response = await fetch(
  "https://api.burki.dev/api/v1/campaigns/42/contacts?status=pending&per_page=100",
  {
    headers: {
      "Authorization": "Bearer YOUR_API_KEY"
    }
  }
);

const data = await response.json();
data.contacts.forEach(contact => {
  console.log(`${contact.phone_number}: ${contact.status}`);
});

console.log(`Page ${data.pagination.page} of ${data.pagination.total_pages}`);

​
Error Responses

Status CodeDescription
400Invalid status value
404Campaign not found
401Unauthorized

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
campaign_id
integer
required

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:50
Required range: 1 <= x <= 1000
​
status
string | null

Response

Successful Response