GET/v1/campaigns
Campaigns
List Campaigns
Returns your campaigns, newest first, each with its status, the number and assistant it calls with, and progress counts for its leads.
Request
Endpoint
GET
/v1/campaignsAuthentication
x-api-keyorAuthorization: BearerQuery 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 | "active" returns only the campaign occupying your one campaign slot. Defaults to "all". allactive |
Response Example
response.json
{
"success": true,
"data": [
{
"id": "6710b2c3d4e5f60718293a40",
"campaign_number": "48213907",
"status": "running",
"is_active": true,
"started": true,
"started_at": "2026-10-19T09:31:00.000Z",
"phone_number": "+918000012345",
"assistant_id": "66aa2b3c4d5e6f7a8b9c0d11",
"uses_shared_number": false,
"channels": 2,
"leads_submitted": 2,
"leads_queued_for_calls": 1,
"leads_scheduled_for_follow_up": 1,
"progress": {
"total": 2,
"called": 1,
"failed": 0,
"scheduled": 1,
"pending": 0,
"cancelled": 0,
"percent_complete": 50,
"is_finished": false
},
"failure_reason": null,
"created_at": "2026-10-19T09:30:00.000Z",
"updated_at": "2026-10-19T09:33:00.000Z",
"completed_at": null
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1
}
}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. |
| 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.