Skip to Content
Alienmail Docs
Leads

List leads

GET
/campaigns/{id}/leads

The leads of a campaign, newest first. Leads that were removed from the campaign are not listed.

Requires the CAMPAIGN_READ permission.

Authorization

apiKey
headerAuthorizationBearer <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.

Path Parameters

id*integer

The 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.

Query Parameters

status?string

Only leads with this status.

Value in"pending""active""stopped""completed""unsubscribed""bounced""skipped"
search?string

Only leads whose email, first name, last name or company contains this text. Search for a full email address to look up one lead.

limit?integer

Items 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.

Range1 <= value <= 100
Default25
cursor?string

The nextCursor of the previous page. Anything else returns 400.

Response Body

A page of leads.

application/json
  1. response
data*array<>
nextCursor*|

Pass as cursor to get the next page. null on the last page.

Example Request
curl -X GET 'https://app.alienmail.io/api/v1/campaigns/42/leads'
Example Response
{  "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}