Skip to main content
GET
/
v4
/
workflows
/
{workflowId}
/
history
Get the workflow run history
curl --request GET \
  --url https://api.kadoa.com/v4/workflows/{workflowId}/history \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.kadoa.com/v4/workflows/{workflowId}/history"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.kadoa.com/v4/workflows/{workflowId}/history', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kadoa.com/v4/workflows/{workflowId}/history",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.kadoa.com/v4/workflows/{workflowId}/history"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.kadoa.com/v4/workflows/{workflowId}/history")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.kadoa.com/v4/workflows/{workflowId}/history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "workflowId": "<string>",
  "workflowRuns": [
    {
      "id": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "finishedAt": "2023-11-07T05:31:56Z",
      "screenshot": "<string>",
      "records": 123,
      "errors": [
        {
          "errorCode": "<string>",
          "message": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "screenshot": "<string>",
          "context": {
            "url": "<string>",
            "httpStatus": 123,
            "retryCount": 123,
            "details": "<string>",
            "timestamp": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "credits": 123
    }
  ]
}

Authorizations

x-api-key
string
header
required

API key for authentication

Path Parameters

workflowId
string
required

The unique identifier of the workflow whose runs history is to be retrieved

Response

History of workflow runs

workflowId
string

Unique identifier of the workflow

workflowRuns
object[]