Skip to Content
CallMitraDocs
API referenceCampaigns

List a campaign's leads

Active leads of the campaign, newest first, with their per-campaign dialing state. Send `page` to get one page of `limit` leads; without `page` every matching lead is returned in one response, so always send it for large campaigns.

GET
/api/v1/campaigns/{campaign_id}/leads

Active leads of the campaign, newest first, with their per-campaign dialing state. Send page to get one page of limit leads; without page every matching lead is returned in one response, so always send it for large campaigns.

Authorization

headerX-API-Key<token>

Create in the console: Settings → API & webhooks.

Path Parameters

campaign_id*string

Campaign ID.

Formatuuid

Query Parameters

page?|

Page number, from 1. Omit to get every matching lead.

limit?Limit

Leads per page when page is sent, 1 to 200.

Range1 <= value <= 200
Default50
search?|

Matches part of the lead's name, phone, email or your ID for the lead.

memberStatus?|

Dialing state in this campaign, for example not_called, calling, completed, failed, no_answer or busy.

sentiment?|

Sentiment of the lead's last call in this campaign, for example positive, neutral or negative.

rules?|

Filter on lead fields, as a JSON object (URL-encoded).

merchantOutcome?|

Outcome of the lead's latest call, for example interested or callback.

Response Body

OK

application/json
  1. response

A campaign's active leads.

hasMore?|

Whether another page follows (only with page).

leads?array<>|

Leads, newest first.

pagination?|

Page position and totals.

success?|

Always true.

[key: string]?any
Example Request
curl -X GET 'https://api.callmitra.ai/api/v1/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/leads'
Example Response
{  "hasMore": false,  "leads": [    {      "callSummary": "",      "id": "5a1d2c3b-4e5f-4a6b-8c7d-9e0f1a2b3c4d",      "lastCallId": "",      "lastSentiment": "positive",      "name": "Asha Rao",      "phone": "+919876543210"    }  ],  "pagination": {    "currentPage": 1,    "hasNextPage": false,    "hasPreviousPage": false,    "itemsPerPage": 50,    "totalItems": 1  },  "success": true}