Start a LinkedIn search import | Swarmhit Developers

JavaScript SDK: swarmhit.leadImports.create(params)

Kicks off a paginated import from a LinkedIn / Sales Navigator search against the connected accountId. Returns immediately with the import running — the worker fetches the first page within a minute. Each stored lead counts toward the sender's daily search-import limit; when it is reached the import waits until midnight UTC and stays running. An unknown or disconnected accountId, a Sales Navigator search on a sender without Sales Navigator, or an unknown listId / campaignId is a 400 (an unknown id has code: not-found), as is sending both or neither of url and params.

Provide either:

url: a copied LinkedIn search URL (classic or Sales Navigator), or
params: a structured filter blob ({ api, category, keywords, ... }).

Imported leads land in listId if provided; otherwise a new list is auto-created and returned in the response. With campaignId instead, they land in that campaign's own list (created if it doesn't exist yet) and are enrolled in the campaign page by page, subject to its exclusion rules.

Authorization

bearerAuth

AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

accountId*string

LinkedIn sender account ID to run the search through.

url?string

Raw LinkedIn search URL (Classic or Sales Navigator).

params?

Structured LinkedIn search filter: api (classic | sales_navigator), category (people, the default) and at least one filter. Filter ids (location, industry, company, …) must be strings (e.g. "2579", not 2579). Classic uses flat arrays (company: ["2579"]) while Sales Navigator uses include/exclude objects (company: { include: ["2579"] }).

listId?string

Destination list ID. Omit to auto-create.

listName?string

Name for the auto-created list. Ignored if listId is set.

campaignId?string

Import into this campaign. Its own list is the destination (created if missing), and imported leads are enrolled. Takes precedence over listId and listName.

name?string

Human-readable label for the import row.

maxLeads?integer

Cap on how many leads this import will store, leads already in the workspace included. At most 2500; a missing or non-positive value means 100.

Default100

tags?array<string>

Tags added to the leads the import creates (up to 20, 50 characters each); leads already in the workspace keep theirs.

Response Body

`application/json`

curl -X POST "https://example.com/lead-imports" \  -H "Content-Type: application/json" \  -d '{    "accountId": "string"  }'

{  "data": {    "id": "string",    "name": "string",    "linkedinAccountId": "string",    "status": "pending",    "input": {      "mode": "url",      "url": "string",      "params": {}    },    "destination": {      "listId": "string",      "listAutoCreated": true    },    "tags": [      "string"    ],    "maxLeads": 0,    "progress": {      "fetchedPages": 0,      "fetchedItems": 0,      "importedLeads": 0,      "skippedItems": 0,      "totalCount": 0    },    "nextPageAt": "2019-08-24T14:15:22Z",    "error": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "startedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z"  }}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`