/api/v1/linkedin/sales-navigator/people/search
Request bodyrequired
| connectedAccountIdrequired | string · uuid Connected account to act as |
| keywordsoptional | string |
| firstNameoptional | string Matches the first name on the profile. |
| lastNameoptional | string Matches the last name on the profile. |
| locationsoptional | string[] Geography ids from the search parameters endpoint with type=REGION and service=sales_navigator. |
| excludedLocationsoptional | string[] Geographies to leave out of the results. |
| industriesoptional | string[] Industry ids from the search parameters endpoint with type=SALES_INDUSTRY and service=sales_navigator. |
| excludedIndustriesoptional | string[] Industries to leave out of the results. |
| companiesoptional | string[] Current-company ids from the search parameters endpoint with type=COMPANY and service=sales_navigator. |
| excludedCompaniesoptional | string[] Current companies to leave out of the results. |
| pastCompaniesoptional | string[] Past-company ids from the search parameters endpoint with type=COMPANY and service=sales_navigator. |
| excludedPastCompaniesoptional | string[] Past companies to leave out of the results. |
| companyLocationsoptional | string[] Where the company sits, rather than where the person does. Geography ids with type=REGION and service=sales_navigator. |
| excludedCompanyLocationsoptional | string[] Company geographies to leave out of the results. |
| companyHeadcountsoptional | "1_to_10" | "11_to_50" | "51_to_200" | "201_to_500" | "501_to_1000" | "1001_to_5000" | "5001_to_10000" | "10001_plus"[] Employee-count bands of the current company. |
| companyTypesoptional | "public_company" | "privately_held" | "non_profit" | "educational_institution" | "partnership" | "self_employed" | "self_owned" | "government_agency"[] How the current company is held. |
| schoolsoptional | string[] School ids from the search parameters endpoint with type=SCHOOL and service=sales_navigator. |
| excludedSchoolsoptional | string[] Schools to leave out of the results. |
| functionsoptional | string[] The department someone works in. Function ids from the search parameters endpoint with type=DEPARTMENT and service=sales_navigator. |
| excludedFunctionsoptional | string[] Functions to leave out of the results. |
| jobTitlesoptional | string[] Current job-title ids from the search parameters endpoint with type=JOB_TITLE and service=sales_navigator. |
| excludedJobTitlesoptional | string[] Current job titles to leave out of the results. |
| pastJobTitlesoptional | string[] Job titles someone used to hold. Ids with type=JOB_TITLE and service=sales_navigator. |
| excludedPastJobTitlesoptional | string[] Past job titles to leave out of the results. |
| senioritiesoptional | "owner_partner" | "cxo" | "vice_president" | "director" | "experienced_manager" | "entry_level_manager" | "strategic" | "senior" | "entry_level" | "in_training"[] Seniority levels to search, from owner_partner down to in_training. |
| excludedSenioritiesoptional | "owner_partner" | "cxo" | "vice_president" | "director" | "experienced_manager" | "entry_level_manager" | "strategic" | "senior" | "entry_level" | "in_training"[] Seniority levels to leave out of the results. |
| yearsOfExperienceoptional | "less_than_1" | "1_to_2" | "3_to_5" | "6_to_10" | "more_than_10"[] Years of experience across someone's whole career. |
| yearsAtCompanyoptional | "less_than_1" | "1_to_2" | "3_to_5" | "6_to_10" | "more_than_10"[] Years spent at the current company. |
| yearsInPositionoptional | "less_than_1" | "1_to_2" | "3_to_5" | "6_to_10" | "more_than_10"[] Years spent in the current position. |
| groupsoptional | string[] LinkedIn groups the person belongs to. Group ids with type=GROUPS and service=sales_navigator. |
| personasoptional | string[] Personas saved on the Sales Navigator seat. Ids with type=PERSONA and service=sales_navigator. |
| accountListsoptional | string[] Only people at companies on these saved account lists. Ids with type=ACCOUNT_LISTS and service=sales_navigator. |
| excludedAccountListsoptional | string[] Saved account lists to leave out of the results. |
| leadListsoptional | string[] Only people on these saved lead lists. Ids with type=LEAD_LISTS and service=sales_navigator. |
| excludedLeadListsoptional | string[] Saved lead lists to leave out of the results. |
| connectionsOfoptional | string[] Member ids from the search parameters endpoint with type=CONNECTIONS. Returns people connected to them. |
| profileLanguagesoptional | string[] ISO 639-1 profile-language codes from the search parameters endpoint with type=LANGUAGE. |
| networkDistancesoptional | number[] LinkedIn connection degrees: first, second, or third-plus. |
| spotlightsoptional | "changed_jobs" | "posted_on_linkedin" | "mentioned_in_news" | "following_your_company" | "viewed_your_profile_recently" | "past_colleague" | "shared_experiences"[] Sales Navigator's Spotlights: recent signals about the person rather than facts about their profile. |
| interactedWithoptional | "messaged" | "viewed_profile"[] Only people this seat has messaged, or whose profile it opened. |
| includeSavedoptional | "leads" | "accounts"[] Also return people already saved as leads, or at saved accounts. |
| searchUrloptional | string · uri Use a lead search URL copied from Sales Navigator, such as https://www.linkedin.com/sales/search/people?query=.... The filters it carries replace the filter fields, which must then be left out. Standard LinkedIn URLs go to POST /api/v1/linkedin/people/search. |
| cursoroptional | string |
| limitoptional | integer |
Response
200Search hits and an optional cursor.
| hits | object[] |
| cursor | string | null |
| requestId | string · uuid Id of this request, for support and troubleshooting |
Errors
- 400: Bad request
- 401: Unauthorized: missing or invalid API key
- 403: Forbidden
- 404: Not found
- 422: Invalid request payload