st.retrieveCompanyEmployees

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

Constraints

⏺️ Root Start: not allowed.

⬆️ Parent Actions: st.openCompanyPage.

⬇️ Child Actions: st.doForPeople.

Parameters

json

{
  "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"],
    "connectionDegrees": ["2nd"]
  },
  "then": { ... }
}

label (optional) – custom label for tracking this action in workflow completion.
limit – (optional) maximum number of employees to retrieve. Defaults to 10, with a maximum value of 1000.
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.
- connectionDegrees (optional) – array of enums representing your connection degree to the employee. Matches if the employee is at any of the listed degrees. Options:
  - 1st – your 1st-degree connections.
  - 2nd – your 2nd-degree connections.
  - 3rd+ – 3rd-degree connections and beyond.
then (optional) – object or array of child actions to be executed within this action.

Result options

Successful retrieval:

json

{
  "actionType": "st.retrieveCompanyEmployees",
  "label": "company1Employees",
  "success": true,
  "data": [
    {
      "name": "John Doe",
      "urn": "urn:li:member:123456789",
      "publicUrl": "https://www.linkedin.com/in/johndoe",
      "headline": "Manager at TechCorp",
      "location": "New York, USA",
      "avatarUrl": "https://media.licdn.com/dms/image/v2/D5603AQE/profile-displayphoto-shrink_100_100/0/1700000000000",
      "viewerState": { "connectionDegree": "2nd" },
      "then": { ... }
    },
    {
      "name": "Jane Smith",
      "urn": null,
      "publicUrl": "https://www.linkedin.com/in/janesmith",
      "headline": "Software Engineer at TechCorp",
      "location": "San Francisco, USA",
      "avatarUrl": null,
      "viewerState": { "connectionDegree": "2nd" },
      "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.
- urn – URN of the employee, or null if LinkedIn does not expose it.
- publicUrl – public LinkedIn URL of the employee.
- headline – headline of the employee.
- location – free-form string indicating the employee's location.
- avatarUrl – URL of the employee's profile photo, or null if the employee has no photo.
- viewerState – how your account relates to the employee, see viewer state.
  - connectionDegree – 1st, 2nd, or 3rd+, as LinkedIn shows it next to the name, or null if LinkedIn does not show it.

Failed retrieval:

json

{
  "actionType": "st.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:
- filterNotApplied – LinkedIn offered no matching option for one or more filter values. The message lists each field and value, so correct or remove them rather than retrying.
- retrievingNotAllowed – LinkedIn has blocked performing the retrieval due to exceeding limits or other restrictions.

Previousst.openCompanyPage Nextst.retrieveCompanyDMs