List leads
The leads of a campaign, newest first. Leads that were removed from the campaign are not listed.
Requires the CAMPAIGN_READ permission.
apiKeyAuthorizationBearer <token>An API key of your workspace, from Workspace settings, Integrations. Each key has a role, and the role decides which endpoints it may call.
id*integerThe campaign id: the number in the campaign URL in Alienmail, or id from the campaign list. An id that is not a campaign of your workspace returns 404.
status?stringOnly leads with this status.
"pending""active""stopped""completed""unsubscribed""bounced""skipped"search?stringOnly leads whose email, first name, last name or company contains this text. Search for a full email address to look up one lead.
limit?integerItems per page, 1 to 100. Default 25. A number outside that range is rounded to the nearest limit (0 is 1, 500 is 100) and a fraction rounded down; anything that is not a number is the default.
1 <= value <= 10025cursor?stringThe nextCursor of the previous page. Anything else returns 400.
A page of leads.
application/json- response
data*array<>nextCursor*|Pass as cursor to get the next page. null on the last page.
curl -X GET 'https://app.alienmail.io/api/v1/campaigns/42/leads'{ "data": [ { "email": "ada@example.com", "status": "active", "firstName": "Ada", "lastName": "Lovelace", "salutation": "Ms.", "jobTitle": "Head of Engineering", "department": "Engineering", "seniority": "Director", "phone": "+44 20 7946 0958", "linkedinUrl": "https://www.linkedin.com/in/ada-lovelace", "gender": "female", "timezone": "Europe/London", "language": "en", "company": "Analytical Engines", "companyDomain": "analyticalengines.com", "industry": "Software", "companySize": "51-200", "revenue": "$10M-$50M", "linkedinCompanyUrl": "https://www.linkedin.com/company/analytical-engines", "city": "London", "state": "England", "country": "United Kingdom", "countryCode": "GB", "description": "Met at the Manchester meetup.", "custom": { "plan": "pro", "renewal_date": "2027-01-04" }, "lastSentAt": "2026-11-13T09:30:00.000Z", "addedAt": "2026-11-13T09:30:00.000Z", "updatedAt": "2026-11-13T09:30:00.000Z" } ], "nextCursor": null}Pause a campaign POST
Stops sending: emails that were waiting to go out are taken off the queue. Start the campaign again to resume; each lead then continues with their next email. A campaign that is already `paused` is returned unchanged.
Add leads POST
Adds up to 500 people to a campaign by email. In an `active` campaign a new lead's first email is queued at once; in a `draft` or `paused` one they wait as `pending` until it starts. Adding to a `completed` campaign makes it `active` again.