Campaigns
List Leads
Returns a campaign's leads, newest first. Filter by status (e.g. replied, in_sequence) or search an email substring.
Note that added means "not yet enrolled", which in practice only happens while the campaign has no published sequence — leads added to a paused campaign are already in_sequence with their next step held.
get/api/v1/campaigns/{campaign_id}/leads
Request
- Base URLhttp://localhost:3009
- AuthHTTP bearer
Path parameters
campaign_idstring required
Campaign ID
Query parameters
page_nostring
1-indexed page number (default: 1)
page_sizestring
Leads per page (default: 20, max: 200)
status'added' | 'in_sequence' | 'completed' | 'removed' | 'replied' | 'responded' | 'unsubscribed' | 'suppressed' | 'bounced'
Filter by lead status
searchstring
Case-insensitive email substring match
Response
Default Response
Changes
No recorded changes to this operation across all 1 revision of this API.