Start a LinkedIn search import | Swarmhit Developers

Kicks off a paginated import from a LinkedIn / Sales Navigator search against the connected accountId. Returns immediately — the worker picks the job up on its next cron tick (within 1 minute).

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.

Authorization

bearerAuth

AuthorizationBearer <token>

An API key created under Settings → API & Webhooks.

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. Required keys: api (classic | sales_navigator) and category (people). 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.

name?string

Human-readable label for the import row.

maxLeads?integer

Cap on how many leads this import will store. Clamped to [1, 2500].

Default100

tags?array<string>

Tags applied to leads as they're imported.

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

404application/json

`application/json`

`application/json`

`application/json`

`application/json`