Skip to content
Examples

Update Settings

Configure scraper settings for Sales Navigator Leads Scraper including email enrichment

The v1 API, for batchesSquids, tasks and runs: many calls on a schedule, delivered where you work. For one call that answers in seconds, use the API v2.
POSThttps://api.lobstr.io/v1/squids/{squid_hash}

Configure your squid settings for the Sales Navigator Leads Scraper. This scraper supports email enrichment and requires linked Sales Navigator accounts.

Headers

Authorizationstringheaderrequired

Your API authentication token. Value: Token YOUR_API_KEY

Content-Typestringheaderrequired

Request body format. Value: application/json

Scraper Parameters

Set these parameters in the params object:

Parameter Type Default Description
functions.email_enrichment boolean false Enable email enrichment using lobstr.io's service (9 credits per profile where an email is found)
functions.mobile_enrichment boolean false Enable mobile phone enrichment (300 credits per profile where a mobile number is found)
get_profile_details boolean false Fetch additional profile data: current role description and profile banner URL
profiles_per_page integer 25 Number of leads to scrape per page (max: 25)
max_pages integer 100 Maximum number of pages to crawl (max: 100)
max_results integer — Total leads to collect before stopping
max_unique_results_per_run integer — Maximum unique results across all tasks in the run
start_page integer — Page number to start scraping from (useful for resuming or skipping already-collected pages)
skip_collected_leads boolean false Skip leads already present in your results database — useful for incremental runs
split_search boolean false Split the search into smaller sub-searches to bypass Sales Navigator's 2,500-result cap. Use for broad searches that would otherwise be truncated.

Squid Settings

Configure general squid settings:

Setting Type Description
name string Display name for your squid configuration
accounts array Array of linked Sales Navigator account hashes (required)
export_unique_results boolean Export only unique results (deduplicated)
to_complete boolean Run until all tasks complete
no_line_breaks boolean Remove line breaks from results

Enabling functions.email_enrichment incurs additional credit costs for email enrichment.

Use multiple Sales Navigator accounts in the accounts array to increase throughput and avoid rate limits.

Sales Navigator limits search results to 2,500 leads per search. Enable split_search to automatically break large searches into sub-searches and collect beyond this limit.

Backward compatibility: The old function name email is still accepted but deprecated. Migrate to email_enrichment.

Code Examples

curl -X POST "https://api.lobstr.io/v1/squids/YOUR_SQUID_HASH" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sales Navigator Leads Scraper (1)",
    "accounts": ["YOUR_SALES_NAV_ACCOUNT_HASH"],
    "no_line_breaks": true,
    "export_unique_results": true,
    "to_complete": false,
    "params": {
      "functions": {
        "email_enrichment": true
      },
      "profiles_per_page": 25,
      "max_pages": 100,
      "max_results": null
    }
  }'

Response

201
{
  "name": "Sales Navigator Leads Scraper (1)",
  "no_line_breaks": true,
  "params": {
    "functions": {
      "email_enrichment": true
    },
    "max_pages": 100,
    "max_results": null,
    "profiles_per_page": 25
  },
  "to_complete": false,
  "export_unique_results": true
}