Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | integer | The campaign ID. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number. Defaults to 1. |
per_page | integer | Results per page. Defaults to 50. |
state | string | Filter by lead state. Enum: pending, leased, dialing, amd_pending, in_progress, completed, failed, canceled. |
q | string | Search by lead name or phone number. |
Response
{
"success": true,
"data": {
"leads": [
{
"id": 1,
"campaign_id": 1,
"name": "John Doe",
"phone_number": "+15551234567",
"lead_timezone": "America/New_York",
"custom_vars": {
"company": "Acme Corp"
},
"state": "pending",
"attempt_count": 0,
"last_outcome": null,
"last_attempt_at": null,
"created_at": "2025-01-10T14:35:00",
"updated_at": "2025-01-10T14:35:00"
}
],
"total": 1,
"page": 1,
"page_size": 50,
"total_pages": 1
}
}