Skip to main content
GET
/
api
/
v1
/
campaigns
/
{campaign_id}
/
leads
curl "https://server.smartlead.ai/api/v1/campaigns/123/leads?api_key=YOUR_KEY&limit=50&status=INPROGRESS&emailStatus=is_opened"
{
  "total_leads": "42",
  "offset": 0,
  "limit": 50,
  "data": [
    {
      "campaign_lead_map_id": 2433664091,
      "lead_category_id": null,
      "status": "INPROGRESS",
      "created_at": "2025-11-25T12:54:54.000Z",
      "lead": {
        "id": 2995276770,
        "first_name": "John",
        "last_name": "Doe",
        "email": "john@example.com",
        "phone_number": "+1234567890",
        "company_name": "Acme Corp",
        "website": "https://acme.com",
        "location": "San Francisco, CA",
        "linkedin_profile": "https://linkedin.com/in/johndoe",
        "company_url": "https://acme.com",
        "custom_fields": {
          "job_title": "CEO",
          "industry": "Technology"
        },
        "is_unsubscribed": false,
        "unsubscribed_client_id_map": null
      }
    }
  ]
}
Supports filtering by status, category, email engagement, and date ranges. Returns lead details with custom fields. Maximum 100 leads per page.

Path Parameters

campaign_id
number
required
The campaign ID to retrieve leads from

Query Parameters

api_key
string
required
Your SmartLead API key
offset
number
default:"0"
Pagination offset (minimum: 0)
limit
number
default:"100"
Number of leads to return per page (minimum: 1, maximum: 100)
status
string
Filter by lead status. Valid values: STARTED, INPROGRESS, COMPLETED, PAUSED, STOPPED
lead_category_id
number
Filter by category ID (must be a positive integer)
emailStatus
string
Filter by email engagement status. Valid values: is_opened, is_clicked, is_replied, is_bounced, is_unsubscribed, is_spam, is_accepted, not_replied, is_sender_bounced
created_at_gt
string
Filter leads created after this ISO 8601 date (e.g., 2025-11-25T00:00:00.000Z)
last_sent_time_gt
string
Filter leads with last email sent after this ISO 8601 date
event_time_gt
string
Filter leads with any activity (sent or reply) after this ISO 8601 date
curl "https://server.smartlead.ai/api/v1/campaigns/123/leads?api_key=YOUR_KEY&limit=50&status=INPROGRESS&emailStatus=is_opened"

Response Fields

total_leads
string
Total count of leads matching the filter criteria
offset
number
The offset used in the request
limit
number
The limit used in the request
data
array
Array of lead objects

Response Codes

200
Success
Leads retrieved successfully
401
Unauthorized
Invalid or missing API key
404
Not Found
Campaign not found or you don’t have access to it
422
Validation Error
Invalid query parameters (check offset, limit ranges and status values)
500
Internal Server Error
Server error occurred
{
  "total_leads": "42",
  "offset": 0,
  "limit": 50,
  "data": [
    {
      "campaign_lead_map_id": 2433664091,
      "lead_category_id": null,
      "status": "INPROGRESS",
      "created_at": "2025-11-25T12:54:54.000Z",
      "lead": {
        "id": 2995276770,
        "first_name": "John",
        "last_name": "Doe",
        "email": "john@example.com",
        "phone_number": "+1234567890",
        "company_name": "Acme Corp",
        "website": "https://acme.com",
        "location": "San Francisco, CA",
        "linkedin_profile": "https://linkedin.com/in/johndoe",
        "company_url": "https://acme.com",
        "custom_fields": {
          "job_title": "CEO",
          "industry": "Technology"
        },
        "is_unsubscribed": false,
        "unsubscribed_client_id_map": null
      }
    }
  ]
}