Returns the lead's progress in this campaign, including its full step history.
Authorization
bearerAuth An API key created under Settings → API & Webhooks.
In: header
Path Parameters
The lead's id.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/campaigns/string/leads/string"{ "data": { "campaignId": "string", "leadId": "string", "linkedinAccountId": "string", "emailAccountId": "string", "status": "pending", "firstName": "string", "lastName": "string", "headline": "string", "company": "string", "picture": "string", "profileUrl": "string", "publicIdentifier": "string", "email": "string", "openProfile": true, "customVariables": { "property1": "string", "property2": "string" }, "interest": "interested", "interestBy": "manual", "currentStepId": "string", "waitUntil": "2019-08-24T14:15:22Z", "heldBy": { "campaignId": "string", "campaignName": "string", "senderName": "string" }, "invitationSentAt": "2019-08-24T14:15:22Z", "invitationAccepted": true, "invitationAcceptedAt": "2019-08-24T14:15:22Z", "invitationWithdrawnAt": "2019-08-24T14:15:22Z", "messageSentAt": "2019-08-24T14:15:22Z", "lastReplyAt": "2019-08-24T14:15:22Z", "emailOpenedAt": "2019-08-24T14:15:22Z", "emailClickedAt": "2019-08-24T14:15:22Z", "finishedAt": "2019-08-24T14:15:22Z", "error": "string", "createdAt": "2019-08-24T14:15:22Z", "history": [ {} ] }}Add leads to a campaign POST
Adds leads from a `leads` array of `{ profileUrl, ... }` objects (or `{ email, ... }` when the workspace has the email channel, see `LeadInput`), or imports a whole lead list with `listId`. The workspace lead is upserted from the fields you pass and enrolled in one call — you don't need to create leads separately first. Caller-supplied fields win over the best-effort LinkedIn lookup. Leads already in the campaign are skipped. Max 1000 leads per request. Every enrolled lead is also saved to the campaign's own list, created on the first enrollment and named "<campaign name>'s leads" (exposed as `listId` on the campaign). That list and the campaign stay in step: adding leads to it enrolls them, removing leads from it removes them from the campaign. Leads imported with `listId` keep their source list too. The response's `listId` is the campaign's own list for a `leads` array, or the source list for a `listId` import.
List the leads in a campaign GET
The leads in a campaign and each one's progress (step, invite sent/accepted, replied, interest).