API Documentation

Leads

Lead Search

Advanced LinkedIn lead search with 30+ filters including seniority, function, geography, company, title, Sales Navigator URL, and exclusion filter support.

POST

/api/v1/lead_search

10 credits per call + 0.5 credits per record

Parameters

Field	Type	Required	Description
`search_query`	text	No	Fuzzy keyword search.
`sales_nav_url`	text	No	Full LinkedIn Sales Navigator search URL. May be combined with individual filters.
`locations`	array	No	Location names
`geo_ids`	array	No	LinkedIn geo IDs or location names
`seniority`	array	No	Seniority labels resolved to LinkedIn seniorityLevelIds.
`functions`	array	No	Job function labels resolved to LinkedIn functionIds.
`industries`	array	No	Industry labels resolved to LinkedIn industryIds.
`company_size`	array	No	Company size ranges.
`years_of_experience`	array	No	Experience range labels resolved to LinkedIn yearsOfExperienceIds.
`years_at_current_company`	array	No	Tenure range labels resolved to LinkedIn yearsAtCurrentCompanyIds.
`profile_languages`	array	No	Profile language labels resolved to language codes.
`current_companies`	array	No	Current company LinkedIn URLs or IDs.
`past_companies`	array	No	Past company LinkedIn URLs or IDs.
`current_job_titles`	array	No	Current job title filters.
`past_job_titles`	array	No	Past job title filters.
`first_names`	array	No	First name filters.
`last_names`	array	No	Last name filters.
`schools`	array	No	School LinkedIn URLs or IDs.
`recently_changed_jobs`	bool	No	Filter for people who recently changed jobs.
`company_headquarter_locations`	array	No	Company headquarters location filters.
`exclude_seniority`	array	No	Seniority labels to exclude.
`exclude_industries`	array	No	Industry labels to exclude.
`exclude_functions`	array	No	Job function labels to exclude.
`exclude_locations`	array	No	Location text values to exclude.
`exclude_geo_ids`	array	No	LinkedIn geo IDs or location names to exclude.
`exclude_current_companies`	array	No	Current company LinkedIn URLs or IDs to exclude.
`exclude_past_companies`	array	No	Past company LinkedIn URLs or IDs to exclude.
`exclude_current_job_titles`	array	No	Current job titles to exclude.
`exclude_past_job_titles`	array	No	Past job titles to exclude.
`exclude_schools`	array	No	School LinkedIn URLs or IDs to exclude.
`exclude_company_headquarter_locations`	array	No	Company headquarters locations to exclude.
`page`	int	No	Positive page number for pagination. Defaults to 1.
`session_id`	text	No	Optional unique ID used to keep pagination requests on the same scraping resource. Generate a random string (for example, a UUID) and send the same value with each page request

Example response

json

{
  "elements": [
    {
      "firstName": "Rayara",
      "id": "ACwAAD0vgEYBfTKAh4CcxbRiFnfRzU6XVSI9SaU",
      "lastName": "Chambela Geronimo",
      "linkedinUrl": "https://www.linkedin.com/in/ACwAAD0vgEYBfTKAh4CcxbRiFnfRzU6XVSI9SaU",
      "location": {
        "countryCode": "br",
        "geoId": "101165590",
        "linkedinText": "Santo Andre, Sao Paulo, Brazil"
      },
      "openProfile": false,
      "pictureUrl": "https://media.licdn.com/dms/image/...",
      "premium": false,
      "summary": "Currently pursuing a degree in Systems Analysis and Development..."
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 25,
    "previousElements": 0,
    "totalElements": 12345678,
    "totalPages": 100
  },
  "sessionId": "session_abc123"
}

Code

curl -X POST https://dev-api.richapi.ai/api/v1/lead_search \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "search_query": "founder",
  "sales_nav_url": "https://www.linkedin.com/sales/search/people?query=...",
  "locations": [
    "United States",
    "London"
  ],
  "geo_ids": [
    "United States"
  ],
  "seniority": [
    "Senior",
    "Director"
  ],
  "functions": [
    "Engineering",
    "Sales"
  ],
  "industries": [
    "Software Development",
    "Banking"
  ],
  "company_size": [
    "51-200",
    "201-500"
  ],
  "years_of_experience": [
    "3 to 5 years"
  ],
  "years_at_current_company": [
    "1 to 2 years"
  ],
  "profile_languages": [
    "English"
  ],
  "current_companies": [
    "https://www.linkedin.com/company/microsoft"
  ],
  "past_companies": [],
  "current_job_titles": [
    "VP Engineering"
  ],
  "past_job_titles": [],
  "first_names": [
    "Ada"
  ],
  "last_names": [
    "Lovelace"
  ],
  "schools": [],
  "recently_changed_jobs": true,
  "company_headquarter_locations": [
    "United States"
  ],
  "exclude_seniority": [
    "Entry Level"
  ],
  "exclude_industries": [],
  "exclude_functions": [],
  "exclude_locations": [
    "India"
  ],
  "exclude_geo_ids": [],
  "exclude_current_companies": [],
  "exclude_past_companies": [],
  "exclude_current_job_titles": [],
  "exclude_past_job_titles": [],
  "exclude_schools": [],
  "exclude_company_headquarter_locations": [],
  "page": 1,
  "session_id": ""
}'

Try it