Skip to main content
POST
Initiates a lead extraction campaign to scrape leads from LinkedIn search results. Requires an active LinkedIn account connected to your workspace.

Request

string
required
Your API key
string
required
A name for this extraction campaign
string[]
required
LinkedIn search URLs to extract leads from
number
required
Maximum number of leads to extract (1-10000)
string
default:"linkedin_search"
Type of URLs provided: linkedin_search or sales_navigator
string
default:"extraction_only"
Extraction mode: extraction_only or with_enrichment

Response

string
Unique identifier for the campaign
string
Name of the campaign
string
Current status: pending, running, completed, failed, cancelled
string
ISO 8601 timestamp when the campaign was created
number
Estimated credits that will be consumed
Credits are calculated as: 1 credit per lead for extraction, plus 1 additional credit per lead if enrichment is enabled.

Authorizations

X-API-Key
string
header
required

API key for authentication

Body

application/json
name
string
required

A name for this extraction campaign

urls
string[]
required

LinkedIn search URLs to extract leads from

Minimum array length: 1
limit
integer
required

Maximum number of leads to extract

Required range: 1 <= x <= 10000
url_type
enum<string>
default:linkedin_search

Type of URLs provided

Available options:
linkedin_search,
sales_navigator
mode
enum<string>
default:extraction_only

Extraction mode

Available options:
extraction_only,
with_enrichment

Response

Campaign created successfully

id
string
required
status
enum<string>
required
Available options:
pending,
running,
completed,
failed,
cancelled
name
string
created_at
string<date-time>
estimated_credits
integer

Estimated credits that will be consumed