st.retrieveCompanyEmployees

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

Constraints

Paramenters

{
  "actionType": "st.retrieveCompanyEmployees",
  "label": "company1Employees",
  "limit": 300,
  "filter": {
    "firstName": "John",
    "lastName": "Doe",
    "position": "Manager",
    "locations": ["New York", "San Francisco", "London"],
    "industries": ["Software Development", "Professional Services"],
    "schools": ["Harvard University", "MIT"]
  },
  "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.
  • position (optional) – job position of employee.
  • 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.
• then (optional) – object or array of child actions to be executed within this action.

Result options

This action always completes successfully. Even if the company has no employees, it returns an empty array.

{
  "actionType": "st.retrieveCompanyEmployees",
  "label": "company1Employees",
  "success": true,
  "data": [
    {
      "name": "John Doe",
      "publicUrl": "https://www.linkedin.com/in/johndoe",
      "headline": "Manager at TechCorp",
      "location": "New York, USA",
      "then": { ... }
    },
    {
      "name": "Jane Smith",
      "publicUrl": "https://www.linkedin.com/in/janesmith",
      "headline": "Software Engineer at TechCorp",
      "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.
  • publicUrl – public LinkedIn URL of the employee.
  • headline – headline of the employee.
  • location – free-form string indicating the employee's location.
• then – results of child actions execution.