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:

⏺️ 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:

json
{
  "actionType": "st.openPersonPage",
  "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).

A parameter the root action does not define is rejected with invalidWorkflow rather than ignored. The message names the field and, when a valid one is close enough, suggests it – for example, unknown field 'filter.fromMember' — did you mean 'fromMembers'?; otherwise it lists the valid fields. This keeps a misspelled filter from silently running an unfiltered action. Parameters of child actions inside then are not checked this way, and actions that take no parameters of their own ignore extra fields.

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:
json
{
  "actionType": "st.checkConnectionStatus",
  "label": "person1", // if included in parameters
  "success": true,
  "data": {
    "connectionStatus": "pending"
  }
}
  • data – object containing action-specific results and child action results.
  1. Unsuccessful execution:
json
{
  "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.

Common errors

Some errors can be returned by any action, regardless of its type:

  • limitExceeded – configured limit for this action category has been exceeded.
  • unexpectedError – unexpected error occurred during action execution.

In addition to these, each action may define its own specific errors (such as personNotFound, messagingNotAllowed, etc.). Refer to the individual action pages for their specific error types.

Available actions

Linked 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.]

Sales Navigator actions [nv.]

  • nv.retrieveAlerts – reads lead and account alerts with filters and sorting.
  • nv.retrieveLists – reads your lead or account lists and the IDs used to save into them.
  • nv.createList – creates a lead or account list with a name you do not already use for that type.
  • nv.deleteList – deletes one of your lists; its leads or accounts stay saved.
  • nv.renameList – renames one of your custom lists to a name you do not already use for that type.
  • nv.retrieveListLeads – reads the leads in one of your lead lists.
  • nv.retrieveListAccounts – reads the accounts in one of your account lists.
  • nv.retrieveSavedSearches – reads your saved lead or account searches and the URLs used to read their results.
  • nv.createSavedSearch – saves a Sales Navigator lead or account search, given its URL.
  • nv.deleteSavedSearch – deletes one of your saved searches by its ID.
  • nv.sendMessage – allows you to send a message to a person in Sales Navigator.
  • nv.syncInbox – allows you to enable whole-inbox monitoring in Sales Navigator so you can poll every incoming conversation.
  • nv.syncConversation – allows you to load the Sales Navigator message history with a person.
  • nv.manageConversation – allows you to manage a conversation thread in Sales Navigator by archiving or unarchiving 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.saveAccount – saves a company as an account, optionally into one of your account lists, so Sales Navigator raises alerts about it.
  • nv.unsaveAccount – unsaves an account; its saved leads stay saved.
  • nv.removeAccountFromList – removes an account from one of your account lists; it stays saved and in your other lists.
  • 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.saveLead – saves a person as a lead, optionally into one of your lead lists, so Sales Navigator raises alerts about them.
  • nv.unsaveLead – unsaves a lead, which also removes them from your custom lead lists.
  • nv.removeLeadFromList – removes a lead from one of your lead lists; they stay saved and in your other lists.
  • 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.