Skip to main content
GET
Supports filtering by status, category, email engagement, and date ranges. Returns lead details with custom fields. Maximum 100 leads per page.

Path Parameters

number
required
The campaign ID to retrieve leads from

Query Parameters

string
required
Your SmartLead API key
number
default:"0"
Pagination offset (minimum: 0)
number
default:"100"
Number of leads to return per page (minimum: 1, maximum: 100)
string
Filter by lead status. Valid values: STARTED, INPROGRESS, COMPLETED, PAUSED, STOPPED
number
Filter by category ID (must be a positive integer)
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
string
Filter leads created after this ISO 8601 date (e.g., 2025-11-25T00:00:00.000Z)
string
Filter leads with last email sent after this ISO 8601 date
string
Filter leads with any activity (sent or reply) after this ISO 8601 date

Response Fields

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

Response Codes

Success
Leads retrieved successfully
Unauthorized
Invalid or missing API key
Not Found
Campaign not found or you don’t have access to it
Validation Error
Invalid query parameters (check offset, limit ranges and status values)
Internal Server Error
Server error occurred