Export Campaign Leads
Exports leads from a campaign with flexible filtering and format options.
Filtering by state
Use thestate parameter to filter leads by their current status. You can:
- Export all leads:
state=all - Filter by specific states:
state=emailsOpened,emailsReplied - Use multiple states:
state=interested,warmed
Global states
These group multiple lead states into a single category:Detailed states
For more granular filtering:Output format
Use theformat parameter to choose between:
csv(default): Returns a CSV file suitable for Excel, Google Sheets, etc.json: Returns structured JSON data for programmatic processing
Examples
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The unique identifier of the campaign
Query Parameters
Filter to export only the specified lead's last states. Use 'all' to export all states. Can be a comma-separated list of states. Global states: imported, scanned, skipped, reviewed, contacted, hooked, attracted, warmed, interested, notInterested, emailsBounced, emailsUnsubscribed, failed, meetingBooked, paused. Detailed states: emailsSent, emailsOpened, emailsClicked, emailsReplied, emailsInterested, emailsNotInterested, emailsFailed, opportunitiesDone, aircallDone, aircallInterested, aircallNotInterested, apiDone, apiInterested, apiNotInterested, linkedinVisitDone, linkedinVisitFailed, linkedinInviteDone, linkedinInviteAccepted, linkedinInviteFailed, linkedinSent, linkedinOpened, linkedinReplied, linkedinInterested, linkedinNotInterested, linkedinSendFailed, manualInterested, manualNotInterested
all, imported, scanned, skipped, reviewed, contacted, hooked, attracted, warmed, interested, notInterested, emailsBounced, emailsUnsubscribed, failed, meetingBooked, paused, emailsSent, emailsOpened, emailsClicked, emailsReplied, emailsInterested, emailsNotInterested, emailsFailed, opportunitiesDone, aircallDone, aircallInterested, aircallNotInterested, apiDone, apiInterested, apiNotInterested, linkedinVisitDone, linkedinVisitFailed, linkedinInviteDone, linkedinInviteAccepted, linkedinInviteFailed, linkedinSent, linkedinOpened, linkedinReplied, linkedinInterested, linkedinNotInterested, linkedinSendFailed, manualInterested, manualNotInterested Output format: 'json' or 'csv'. Default is CSV.
json, csv Response
Leads exported successfully