GET/v1/campaigns/{id}/leads
Campaigns
List Campaign Leads
Returns the campaign's leads in upload order, with each lead's status, why it failed, its call (when one was placed) and the fields you uploaded.
Request
Endpoint
GET
/v1/campaigns/{id}/leadsAuthentication
x-api-keyorAuthorization: BearerPath Parameters
| Name | Type | Description |
|---|---|---|
idrequired | ObjectId | MongoDB ObjectId for the campaign. Invalid ids return 400. |
Query Parameters
| Name | Type | Description |
|---|---|---|
page | integer | Page number. Values below 1 are clamped to 1. |
limit | integer | Maximum items to return. Defaults to 20 and is capped at 100. Passing 0 is clamped to 1. |
status | string | Only leads in this state. pendingscheduledcompletedfailedcancelled |
Response Example
response.json
{
"success": true,
"data": [
{
"id": "6710b2c3d4e5f60718293a4b",
"customer_number": "+919876543210",
"status": "completed",
"attempted_at": "2026-10-19T09:32:10.000Z",
"failure_reason": null,
"call": {
"id": "6710b2d0d4e5f60718293a77",
"status": "completed",
"duration": "00:01:42"
},
"data": {
"mobile": "+919876543210",
"name": "Pankaj",
"plan": "Gold"
},
"created_at": "2026-10-19T09:30:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 2
}
}Status Codes
| HTTP | Meaning | Description |
|---|---|---|
| 200 | OK | Request succeeded. |
| 400 | Bad request | Malformed input, invalid ObjectId, or no updatable fields. |
| 401 | Unauthorized | Missing, invalid, inactive, or origin-restricted API key. |
| 404 | Not found | Resource was not found inside the authenticated user's scope. |
| 429 | Rate limited | Per-IP or per-key request budget was exceeded. |
Security Model
User-scoped by default
This endpoint only sees resources owned by the user attached to the API key. If another user's id is supplied, the API responds as if the resource does not exist.