Actions overview

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

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:

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": "st.checkConnectionStatus",
  "label": "person1",
  "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": "st.checkConnectionStatus",
  "label": "person1", // if included in parameters
  "success": true,
  "data": { 
    "connectionStatus": "pending"
  }
}

• data – object containing action-specific results and child action results.

2. Unsuccessful execution:

{
  "actionType": "st.checkConnectionStatus",
  "label": "person1", // if included in parameters
  "success": false,
  "error": {
    "type": "personNotFound",
    "message": "The provided URL is not an existing LinkedIn person."
  }
}

• error – object containing error details, including type and message.

Available actions

Account API provides 2 types of actions, each with its own namespace:

• Standard actions [st.]: actions that relate to the standard LinkedIn interface.
• Sales Navigator actions [nv.]: actions that relate to the Sales Navigator interface.

Standard actions [st.]

• st.sendMessage – allows you to send a message to a person.
• st.syncConversation – allows you to sync a conversation so you can start polling it.
• st.checkConnectionStatus – allows you to check the connection status between your account and another person.
• st.sendConnectionRequest –  allows you to send a connection request to a person.
• st.withdrawConnectionRequest – allows you to withdraw the connection request sent to a person.
• st.retrievePendingRequests – allows you to retrieve pending connection requests sent from your account.
• st.retrieveConnections – allows you to retrieve your connections and perform additional person-related actions if needed.
• st.removeConnection – allows you to remove a person from your connections.
• st.searchCompanies – allows you to search for companies applying various filtering criteria.
• st.searchPeople – allows you to search for people applying various filtering criteria.
• st.openCompanyPage – allows you to open a company page to retrieve its basic information and perform additional company-related actions if needed.
• st.retrieveCompanyEmployees – allows you to retrieve company employees and perform additional person-related actions if needed.
• st.retrieveCompanyDMs – allows you to retrieve company decision makers and perform additional person-related actions if needed.
• st.retrieveCompanyPosts – allows you to retrieve posts published by a company and perform additional post-related actions if needed.
• st.openPersonPage – allows you to open a person page to retrieve their basic information and perform additional person-related actions if needed.
• st.retrievePersonExperience –  allows you to retrieve information about a person's experience.
• st.retrievePersonEducation – allows you to retrieve information about a person's education.
• st.retrievePersonSkills – allows you to retrieve information about a person's skills.
• st.retrievePersonLanguages – allows you to retrieve information about a person's languages.
• st.retrievePersonPosts – allows you to retrieve posts published by a person and perform additional post-related actions if needed.
• st.retrievePersonComments – allows you to retrieve comments left by a person.
• st.retrievePersonReactions – allows you to retrieve reactions made by a person.
• st.openPost – allows you to open a post to retrieve its data and perform additional post-related actions if needed.
• st.reactToPost – allows you to react to a post using any available reaction type.
• st.commentOnPost – allows you to leave a comment on a post.
• st.doForCompanies – allows you to apply the actions specified in its then parameter to each company provided by the parent action.
• st.doForPeople – allows you to apply the actions specified in its then parameter to each person provided by the parent action.
• st.doForPosts – allows you to apply the actions specified in its then parameter to each post provided by the parent action.
• st.retrieveSSI – allows you to retrieve your current SSI (Social Selling Index).
• st.retrievePerformance – allows you to retrieve performance analytics from your LinkedIn dashboard.

Sales Navigator actions [nv.]

• nv.sendMessage – allows you to send a message to a person in Sales Navigator.
• nv.syncConversation – allows you to sync a conversation in Sales Navigator so you can start polling it.
• nv.searchCompanies – allows you to search for companies in Sales Navigator applying various filtering criteria.
• nv.searchPeople – allows you to search for people in Sales Navigator applying various filtering criteria.
• nv.openCompanyPage – allows you to open a company page in Sales Navigator to retrieve its basic information and perform additional company-related actions if needed.
• nv.retrieveCompanyEmployees – allows you to retrieve company employees from Sales Navigator and perform additional person-related actions if needed.
• nv.retrieveCompanyDMs – allows you to retrieve company decision makers from Sales Navigator and perform additional person-related actions if needed.
• nv.openPersonPage – allows you to open a person page in Sales Navigator to retrieve their basic information and perform additional person-related actions if needed.
• nv.doForCompanies – allows you to apply the actions specified in its then parameter to each company provided by the parent action in Sales Navigator.
• nv.doForPeople – allows you to apply the actions specified in its then parameter to each person provided by the parent action in Sales Navigator.