Skip to main content
GET
/
v4
/
workflows
/
{workflowId}
Get workflow by ID
curl --request GET \
  --url https://api.kadoa.com/v4/workflows/{workflowId} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "state": "ACTIVE",
  "displayState": "ACTIVE",
  "userId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updateInterval": "<string>",
  "schedules": [
    "<string>"
  ],
  "nextInvocation": "2023-11-07T05:31:56Z",
  "monitoring": true,
  "location": {
    "type": "auto",
    "isoCode": "DE"
  },
  "tags": [
    "<string>"
  ],
  "templateName": "<string>",
  "templateId": "<string>",
  "jobId": "<string>",
  "finishedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "dataKey": "<string>",
  "errors": [
    {
      "errorCode": "<string>",
      "message": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "screenshot": "<string>",
      "context": {}
    }
  ],
  "runCosts": 123,
  "runState": "<string>",
  "totalRecords": 123,
  "url": "<string>",
  "urls": [
    "<string>"
  ],
  "browserActions": [
    {
      "type": "<string>",
      "selector": "<string>",
      "text": "<string>",
      "timeMs": 123,
      "url": "<string>"
    }
  ],
  "schema": [
    {
      "name": "<string>",
      "description": "<string>",
      "example": "<string>",
      "dataType": "STRING",
      "isKey": true,
      "isRequired": true,
      "isUnique": true
    }
  ],
  "entity": {},
  "isSchemaEditable": true,
  "limit": 123,
  "additionalData": {},
  "dataValidation": {
    "enabled": true,
    "ruleCounts": {
      "enabled": 123,
      "disabled": 123,
      "preview": 123
    }
  },
  "linkingColumns": [
    "<string>"
  ],
  "dataLinking": {
    "enabled": true,
    "linkingColumns": [
      "<string>"
    ]
  },
  "validationStatistics": {
    "count": 123,
    "change": 123
  },
  "notificationConfig": {
    "enabled": true,
    "fields": [
      {
        "fieldName": "<string>",
        "operator": "changed"
      }
    ]
  },
  "channelCounts": {
    "workflow_data_change": 3,
    "workflow_finished": 1,
    "workflow_failed": 2
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

workflowId
string
required

Response

id
string
name
string
description
string
state
enum<string>
Available options:
ACTIVE,
ERROR,
PAUSED,
NOT_SUPPORTED,
PREVIEW,
COMPLIANCE_REVIEW,
COMPLIANCE_REJECTED,
QUEUED,
SETUP,
DELETED
displayState
enum<string>
Available options:
ACTIVE,
ERROR,
PAUSED,
NOT_SUPPORTED,
PREVIEW,
COMPLIANCE_REVIEW,
COMPLIANCE_REJECTED,
QUEUED,
SETUP,
RUNNING,
DELETED
userId
string
createdAt
string<date-time>
updateInterval
string
schedules
string[]
nextInvocation
string<date-time>
monitoring
boolean
location
object
tags
string[]
templateName
string
templateId
string
jobId
string
finishedAt
string<date-time>
startedAt
string<date-time>
dataKey
string
errors
object[]
runCosts
number
runState
string
totalRecords
integer
url
string
urls
string[]
browserActions
object[]
schema
object[]
entity
object
isSchemaEditable
boolean
limit
integer
additionalData
object
dataValidation
object
linkingColumns
string[]
dataLinking
object
validationStatistics
object
notificationConfig
object
channelCounts
object
Example: