Making requests

This page explains how to make requests to Data API, including endpoints, authorization process, response structure, and common errors.

Endpoints

There is only 1 endpoint in Data API that is used for executing workflows:

https://api.linkedapi.io/data/workflows

Authorization

Your requests must include the authorization header:

• data-api-token – your main token that enables overall Data API access.

You can obtain this token through the Linked API Platform interface, as demonstrated below:

Response structure

All responses in Data API have the following structure:

1. For successful requests:

{
  "success": true,
  "result": { /* Endpoint specific result */ }
}

2. For requests with errors:

{
  "success": false,
  "error": { /* Common or endpoint specific error */ }
}

Common errors

Below is a list of common errors relevant to all requests:

dataApiTokenRequired

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

invalidDataApiToken

{
  "success": false,
  "error": {
    "type": "invalidDataApiToken",
    "message": "The provided 'data-api-token' is invalid."
  }
}

insufficientCredits

{
  "success": false,
  "error": {
    "type": "insufficientCredits",
    "message": "You have no remaining credits for using Data API."
  }
}

invalidRequestPayload

{
  "success": false,
  "error": {
    "type": "invalidRequestPayload",
    "message": "Invalid request body/paramenters: {validation_message}."
  }
}