API referenceLeads
GET
/leads/{id}

JavaScript SDK: swarmhit.leads.get(leadId)

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/leads/string"
{  "data": {    "id": "string",    "firstName": "string",    "lastName": "string",    "headline": "string",    "jobTitle": "string",    "company": "string",    "email": "string",    "phone": "string",    "emailStatus": "bounced",    "emailOptOut": true,    "location": "string",    "picture": "string",    "notes": "string",    "profileUrl": "string",    "publicIdentifier": "string",    "openProfile": true,    "tags": [      "string"    ],    "autoTags": [      "string"    ],    "listIds": [      "string"    ],    "campaignIds": [      "string"    ],    "customVariables": {      "property1": "string",      "property2": "string"    },    "source": "string",    "lastActivityAt": "2019-08-24T14:15:22Z",    "enrichedAt": "2019-08-24T14:15:22Z",    "enrichment": {      "email": {        "status": "pending",        "at": "2019-08-24T14:15:22Z",        "reason": "no_credits"      },      "phone": {        "status": "pending",        "at": "2019-08-24T14:15:22Z",        "reason": "no_credits"      }    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Find emails or phones for many leads POST

**JavaScript SDK:** [`swarmhit.leads.enrichMany(params)`](/smart-api/sdk/methods#leads) Queues a work email and/or mobile phone lookup for each of the given leads (`leadIds`, up to 5000) or every lead of a list (`listId`) and returns at once. A lead is skipped when it already has the value, was looked up before with nothing found, or has nothing to look it up by (a phone needs a LinkedIn profile; an email needs one, or a first name, last name and company). Lookups run in the background, usually within minutes: each result lands on the lead (`email` / `phone`, and `enrichment.<kind>.status`) and fires `lead.enriched`. Charged per result found, at the Email finder or Phone finder price (Settings → Credits usage, for owners and admins); nothing for a miss. Out of credits is a 400 with `code: warning-no-credits` when asking, and a lookup reached after the credits ran out ends `failed` with `reason: no_credits`.

Get a lead's activity GET

**JavaScript SDK:** [`swarmhit.leads.getActivity(leadId)`](/smart-api/sdk/methods#leads) The lead's campaign timeline across every campaign it is in, newest first and capped at 200 events: step results and events such as `invite_sent` (with `result.noteDropped` when it went without its note), `invite_note_sent` (that note sent as a message once they accepted), `invite_accepted`, `reply_received`, `paused`, `interest_changed` (a label that changes `interest`) or `label_changed` (one that leaves it as it was). Inbox messages are not part of it; read them through the inbox endpoints.