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:| State | Description |
|---|---|
imported | Leads imported without processing (not scanned, no steps sent, not reviewed) |
scanned | Leads scanned by LinkedIn or email verification |
skipped | Leads skipped during review |
reviewed | Leads that were reviewed |
contacted | Leads that were contacted (at least one step executed, no response yet) |
hooked | Leads that opened an email or LinkedIn message |
attracted | Leads that clicked in an email or accepted a LinkedIn invite |
warmed | Leads that replied to an email or LinkedIn message |
interested | Leads marked as interested |
notInterested | Leads marked as not interested |
emailsBounced | Leads where at least one step bounced or failed |
emailsUnsubscribed | Leads that unsubscribed |
meetingBooked | Leads that booked a meeting |
paused | Leads that were paused |
Detailed states
For more granular filtering:| State | Description |
|---|---|
emailsSent | Email was sent |
emailsOpened | Lead opened an email |
emailsClicked | Lead clicked on an email |
emailsReplied | Lead replied to an email |
emailsInterested | Lead marked as success via email |
emailsNotInterested | Lead marked as not a success via email |
emailsFailed | Error sending email |
linkedinVisitDone | LinkedIn profile was visited |
linkedinInviteDone | LinkedIn invitation was sent |
linkedinInviteAccepted | LinkedIn invitation was accepted |
linkedinSent | LinkedIn message was sent |
linkedinOpened | LinkedIn message was opened |
linkedinReplied | Lead replied on LinkedIn |
linkedinInterested | Lead marked as success via LinkedIn |
linkedinNotInterested | Lead marked as not a success via LinkedIn |
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
The response is of type file.