Developers
Open Swarmhit
Smart APIRaw API
API referenceLeads
GET
/leads

JavaScript SDK: swarmhit.leads.list(params?)

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Query Parameters

limit?integer

Page size, 1–100.

Range1 <= value <= 100
Default50
offset?integer

Number of records to skip.

Range0 <= value
Default0
search?string

Case-insensitive match on name, headline, job title, email, company or the profile slug (publicIdentifier) — so a lead not yet contacted (no name) is still findable by its URL slug. A full LinkedIn profile URL is reduced to its slug first.

Response Body

application/json

application/json

curl -X GET "https://example.com/leads"
{  "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"    }  ],  "paging": {    "limit": 0,    "offset": 0  }}

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.

Update a lead PATCH

**JavaScript SDK:** [`swarmhit.leads.update(leadId, params)`](/smart-api/sdk/methods#leads) Edit a lead's fields and/or replace its manual `tags`.