Executing workflows

Data API is built around the concept of workflows. This means that any data retrieval operation you want to perform (such as searching for companies, retrieving person 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/data/workflows

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

{
  "actionType": "openCompanyPage",
  "companyUrl": "https://www.linkedin.com/company/company1",
  "basicInfo": true
}

Upon successful request, you will receive the following response:

{
  "success": true,
  "result": {
    "workflowId": "data-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": "dataApiTokenRequired",
    "message": "'data-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}.

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/data/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:

{
  "success": true,
  "result": {
    "workflowStatus": "completed",
    "completion": {
      "actionType": "openCompanyPage",
      "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
      }
    }
  }
}

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