Developers
Open Swarmhit
Smart APIRaw API
API referenceLinkedin search
POST
/api/v1/linkedin/search

A pasted search URL (classic people search, or Sales Navigator people or companies), or search params. A classic search reads one page of LinkedIn's results, with no totals; a Sales Navigator search runs on the account's seat, 25 a page, with totals. One page a call; pass cursor for the next. A filter Swarmhit cannot map is 422: paste the URL instead.

Authorization

X-API-KEY<token>

Your API key from the console (gw_live_…).

In: header

Query Parameters

account_id*string

The LinkedIn account (lg_…) to act as.

Length1 <= length
cursor?string

The cursor the previous page answered, passed back unchanged, for the next page. Leave it out for the first page; a null cursor means there is no next page. Opaque: its form differs by route.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A URL, or search params. A param Swarmhit does not map (classic or Sales Navigator) is refused (422), never dropped: paste the search URL instead.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/linkedin/search?account_id=lg_3f9c2a7b1d" \  -H "Content-Type: application/json" \  -d '{    "api": "classic",    "category": "people",    "keywords": "head of sales",    "location": [      "105015875"    ],    "network_distance": [      2    ]  }'
{  "object": "LinkedinSearch",  "items": [    {      "object": "SearchResult",      "type": "PEOPLE",      "id": "ACoAAB1a2b3c4d5e6f",      "member_urn": null,      "public_identifier": "jane-doe",      "public_profile_url": "https://www.linkedin.com/in/jane-doe",      "profile_url": "https://www.linkedin.com/in/jane-doe",      "name": "Jane Doe",      "first_name": "Jane",      "last_name": "Doe",      "headline": "Head of Sales at Example Corp",      "location": "Paris",      "network_distance": "SECOND_DEGREE",      "profile_picture_url": null,      "current_positions": [        {          "role": "Head of Sales",          "company": "Example Corp"        }      ]    }  ],  "paging": {    "total_count": null,    "page_count": null,    "start": 0  },  "cursor": "2"}

Save a Sales Navigator lead POST

An action on a member: Sales Navigator's `saveLead`, a write (`save` daily cap), on the account's seat. `user_id` is the lead's Sales Navigator id (`ACw…`) or its `urn:li:fs_salesProfile:(…)` from a Sales Navigator search; `list_id` (from `GET /linkedin/lists`) also adds it to that list. Recruiter's pipeline actions answer 422: no account here has a Recruiter seat.

Search companies (Sales Navigator) POST

A Sales Navigator company search URL, or free-text `keywords`. It runs a company search only: any other link (a people or classic search, a Sales Navigator page with no search in it, a blank `query`, a port or user name, over 4,000 characters) is a 400 `bad-request` and nothing runs. Items have `type: COMPANY`; paged like the people search. Needs a Sales Navigator seat (422 `feature_not_subscribed`).