Skip to main content

Actions

nv.retrieveCompanyEmployees

This action allows you to retrieve company employees from Sales Navigator and perform additional person-related actions if needed.

Constraints

⏺️
Root Start: not allowed.
⬆️
Parent Actions: nv.openCompanyPage.
⬇️
Child Actions: nv.doForPeople.

Paramenters


{
  "actionType": "nv.retrieveCompanyEmployees",
  "label": "company1Employees",
  "limit": 300,
  "filter": {
    "firstName": "John",
    "lastName": "Doe",
    "positions": ["Manager", "Executive"],
    "locations": ["New York", "San Francisco", "London"],
    "industries": ["Software Development", "Professional Services"],
    "schools": ["Harvard University", "MIT"],
    "yearsOfExperiences": ["threeToFive", "sixToTen"]
  },
  "then": { ... }
}
  • label (optional) – custom label for tracking this action in workflow completion.
  • limit – (optional) maximum number of employees to retrieve. Defaults to 500, with a maximum value of 500.
  • filter (optional) – object that specifies filtering criteria for employees. When multiple filter fields are specified, they are combined using AND logic.
    • firstName (optional) – first name of employee.
    • lastName (optional) – last name of employee.
    • positions (optional) – array of job position names. Matches if employee's current position is any of the listed options.
    • locations (optional) – array of free-form strings representing locations. Matches if employee is located in any of the listed locations.
    • industries (optional) – array of enums representing industries. Matches if employee works in any of the listed industries. Takes specific values available in the LinkedIn interface.
    • schools (optional) – array of institution names. Matches if employee currently attends or previously attended any of the listed institutions.
    • yearsOfExperiences (optional) – array of enums representing professional experience. Matches if employee’s experience falls within any of the listed ranges. Options:
      • lessThanOne – less than 1 year.
      • oneToTwo – 1 to 2 years.
      • threeToFive – 3 to 5 years.
      • sixToTen – 6 to 10 years.
      • moreThanTen – more than 10 years.
  • then (optional) – object or array of child actions to be executed within this action.

Result options

  1. Successful retrieval:

{
  "actionType": "nv.retrieveCompanyEmployees",
  "label": "company1Employees",
  "success": true,
  "data": [
    {
      "name": "John Doe",
      "hashedUrl": "https://www.linkedin.com/in/SInQBmjJ015eLr8OeJoj0mrkxx7Jiuy0",
      "position": "Manager",
      "location": "New York, USA",
      "then": { ... }
    },
    {
      "name": "Jane Smith",
      "hashedUrl": "https://www.linkedin.com/in/ACoAA2DdsSV83B48UDvgO5jPoу3Gho0o",
      "position": "Software Engineer",
      "location": "San Francisco, USA",
      "then": { ... }
    }
  ]
}
  • label – included only if specified in the action parameters.
  • data – array of company employees with results of child actions execution.
    • name – full name of the employee.
    • hashedUrl – hashed LinkedIn URL of the employee.
    • position – job position of the employee.
    • location – free-form string indicating the employee's location.
    • then – results of child actions execution.
  1. Failed retrieval:

{
  "actionType": "nv.retrieveCompanyEmployees",
  "label": "company1Employees",
  "success": false,
  "error": {
    "type": "retrievingNotAllowed",
    "message": "LinkedIn has blocked performing the retrieval."
  }
}
  • label – included only if specified in the action parameters.
  • error.type – enum with the following possible values:
    • retrievingNotAllowed – LinkedIn has blocked performing the retrieval due to exceeding limits or other restrictions.