Executing workflows

Account API is built around the concept of workflows. This means that any automation you want to perform (such as sending a connection request, commenting on a post, retrieving company data, etc.) must be executed as a workflow.

Executing a workflow consists of 2 key steps:

1. Starting a workflow and receiving its workflowId.
2. Periodically checking for the result using the workflowId.

Starting workflow

To start executing a workflow, make a POST request to the following endpoint:

POST https://api.linkedapi.io/account/workflows

In the request body, include a JSON that describes your workflow, for example:

{
  "actionType": "st.checkConnectionStatus",
  "personUrl": "https://www.linkedin.com/in/person1"
}

Upon successful request, you will receive the following response:

{
  "success": true,
  "result": {
    "workflowId": "account-64835e7c-a0gc-40ae-8338-108f02sSe643"
  }
}

• workflowId – unique workflow identifier for checking the result.

In case of an unsuccessful request, you will receive the following response:

{
  "success": false,
  "error": {
    "type": "accountApiTokenRequired",
    "message": "'account-api-token' is missing in request headers."
  }
}

• error – either a common error or one of the following specific errors:
  • invalidWorkflow – workflow configuration is not valid due to violated action constraints or invalid action parameters: {validation_details}.
• plusPlanRequired – some actions in this workflow require the Plus plan.

Checking for result

After starting your workflow and receiving the workflowId, you need to periodically check the workflow result. To do this, send a GET request to the following endpoint:

GET https://api.linkedapi.io/account/workflows/{workflowId}

Depending on the workflow execution status, you'll receive one of these results:

1. Workflow is still running:

{
  "success": true,
  "result": {
    "workflowStatus": "running"
  }
}

2. Workflow completed successfully:

{
  "success": true,
  "result": {
    "workflowStatus": "completed",
    "completion": {
      "actionType": "st.checkConnectionStatus",
      "success": true,
      "data": {
        "connectionStatus": "pending"
      }
    }
  }
}

• completion – results of all actions included in this workflow.

3. Workflow failed:

{
  "success": true,
  "result": {
    "workflowStatus": "failed",
    "failure": {
      "reason": "linkedinAccountSignedOut",
      "message": "This LinkedIn account has been signed out in our cloud browser."
    }
  }
}

• failure – object describing the workflow failure reason:
  • linkedinAccountSignedOut – your LinkedIn account has been signed out in our cloud browser. This occasionally happens as LinkedIn may sign out accounts after an extended period. You'll need to visit the platform and reconnect your account.
  • languageNotSupported – your LinkedIn account uses a language that is not currently supported. We support all popular languages, but if you encounter this failure, please contact us at support@linkedapi.io, and we will add support for your language.