Skip to main content

Getting Started

Actions overview

Each action represents a specific operation within a workflow. On this page, you'll find details about action definition and a list of all actions available in Data API.

Action definition

Each action is defined by 3 characteristics: constraints, parameters, and result options:

Constraints

Constraints specify the valid parent-child relationships between actions in a workflow (defined using the then parameter in action JSON structure).

On documentation pages, constraints are described with three elements:

⏺️
Root Start: indicates whether an action can be placed at the beginning of a workflow (in the root position).
⬆️
Parent Actions: specifies which actions can be parent actions to this action.
⬇️
Child Actions: specifies which actions can be child actions of this action.

If constraints are violated, you'll receive an invalidWorkflow error.

Parameters

Parameters configure the action's behavior and are unique to each action type. However, there are 3 common parameters:


{
  "actionType": "openCompanyPage",
  "label": "company1",
  "personUrl": "https://www.linkedin.com/in/person1",
  "then": { ... }
}
  • actionType – required value that specifies which action is being executed.
  • label (optional) – custom label for tracking this action in workflow completion. When included, this same label appears in the result JSON, making it easy to locate the action.
  • then (optional) – object or array of child actions to be executed within this action (see constraints for more details).

Result options

Actions can have 2 possible result options: successful and unsuccessful execution, indicated by the success field being either true or false.

The result format is unique for each action type. Here are examples:

  1. Successful execution:

{
  "actionType": "openCompanyPage",
  "label": "company1", // if included in parameters
  "success": true,
  "data": {
    "name": "TechCorp",
    "publicUrl": "https://www.linkedin.com/company/company1",
    "description": "TechCorp is a leading provider of innovative technology solutions for businesses worldwide.",
    "location": "Cupertino, California",
    "headquarters": "US",
    "industry": "Information Technology",
    "specialties": "Cloud Computing, AI, Software Development",
    "website": "https://techcorp.com",
    "employeeCount": 500,
    "yearFounded": 2019,
    "ventureFinancing": true,
    "jobsCount": 12
  }
}
  • data – object containing action-specific results and child action results.
  1. Unsuccessful execution:

{
  "actionType": "openCompanyPage",
  "label": "company1", // if included in parameters
  "success": false,
  "error": {
    "type": "companyNotFound",
    "message": "The provided URL is not an existing LinkedIn company."
  }
}
  • error – object containing error details, including type and message.

Available actions

  • searchCompanies – allows you to search for companies applying various filtering criteria.
  • searchPeople – allows you to search for people applying various filtering criteria.
  • openCompanyPage – allows you to open a company page to retrieve its basic information and perform additional company-related actions if needed.
  • retrieveCompanyEmployees – allows you to retrieve company employees and perform additional person-related actions if needed.
  • retrieveCompanyDMs – allows you to retrieve company decision makers and perform additional person-related actions if needed.
  • retrieveCompanyPosts – allows you to retrieve posts published by a company.
  • openPersonPage – allows you to open a person page to retrieve their basic information and perform additional person-related actions if needed.
  • retrievePersonExperience –  allows you to retrieve information about a person's experience.
  • retrievePersonEducation – allows you to retrieve information about a person's education.
  • retrievePersonSkills – allows you to retrieve information about a person's skills.
  • retrievePersonLanguages – allows you to retrieve information about a person's languages.
  • retrievePersonPosts – allows you to retrieve posts published by a person.
  • retrievePersonComments – allows you to retrieve comments left by a person.
  • retrievePersonReactions – allows you to retrieve reactions made by a person.
  • openPost – allows you to open a post to retrieve its data.
  • doForCompanies – allows you to apply the actions specified in its then parameter to each company provided by the parent action.
  • doForPeople – allows you to apply the actions specified in its then parameter to each person provided by the parent action.