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>'
{
  "workflowId": "<string>",
  "workflowRuns": [
    {
      "id": "<string>",
      "state": "IN_PROGRESS",
      "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[]