searchPeople

This method allows you to search for people applying various filtering criteria.

try {
  const workflowId = await linkedapi.searchPeople.execute({
    term: "John Doe",
    limit: 10,
    filter: {
      firstName: "John",
      lastName: "Doe",
      position: "CEO",
      locations: ["New York", "San Francisco", "London"],
      industries: ["Software Development", "Professional Services"],
      currentCompanies: ["Tech Solutions", "Innovatech"],
      previousCompanies: ["FutureCorp"],
      schools: ["Harvard University", "MIT"]
    },
    customSearchUrl: "https://www.linkedin.com/search/results/people/?geoUrn=%5B%22103644278%22%5D&keywords=Bill%20Gates"
  });
  
  const { data, errors } = await linkedapi.searchPeople.result(workflowId);
  
  // The list of possible execution errors is below
  if (errors && errors.length > 0) {
    console.warn('Workflow completed with execution errors:');
    errors.forEach(error => {
      console.warn(` - Type: ${error.type}, Message: ${error.message}`);
    });
  }
  
  // The structure of the 'data' object is below
  if (data) {
    console.log('Workflow completed successfully. Data:', data);
  }
} catch (e) {
  // A list of all critical errors can be found here:
  // https://linkedapi.io/sdks/handling-results-and-errors/#handling-critical-errors
  if (e instanceof LinkedApiError) {
    console.error(`Critical Error - Type: ${e.type}, Message: ${e.message}`);
  } else {
    console.error('An unexpected, non-API error occurred:', e);
  }
}

# Python SDK is coming soon!
#
# You can always use Linked API through HTTP
# https://linkedapi.io/docs/

// Go SDK is coming soon!
//
// You can always use Linked API through HTTP
// https://linkedapi.io/docs/

Params

• term (optional) – keyword or phrase to search.
• limit (optional) – number of search results to return. Defaults to 10, with a maximum value of 1000.
• filter (optional) – object that specifies filtering criteria for people. When multiple filter fields are specified, they are combined using AND logic.
  • firstName (optional) – first name of person.
  • lastName (optional) – last name of person.
  • position (optional) – job position of person.
  • locations (optional) – array of free-form strings representing locations. Matches if person is located in any of the listed locations.
  • industries (optional) – array of enums representing industries. Matches if person works in any of the listed industries. Takes specific values available in the LinkedIn interface.
  • currentCompanies (optional) – array of company names. Matches if person currently works at any of the listed companies.
  • previousCompanies (optional) – array of company names. Matches if person previously worked at any of the listed companies.
  • schools (optional) – array of institution names. Matches if person currently attends or previously attended any of the listed institutions.
• customSearchUrl (optional) – URL copied from LinkedIn search results page after configuring desired filters. When specified, overrides term and filter parameters. Allows using any search configuration available in the LinkedIn interface.

Data

Array of search results. Each search result contains:

• name – full name of the person.
• publicUrl – public LinkedIn URL of the person.
• headline – headline of the person.
• location – free-form string indicating the person's location.

Errors

• searchingNotAllowed – LinkedIn has blocked performing the search due to exceeding limits or other restrictions.