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",
  "protocol": "<string>",
  "dataKey": "<string>",
  "runCosts": 123,
  "runState": "<string>",
  "totalRecords": 123,
  "url": "<string>",
  "urls": [
    "<string>"
  ],
  "schema": [
    {
      "name": "<string>",
      "description": "<string>",
      "example": "<string>",
      "dataType": "STRING",
      "isPrimaryKey": true,
      "isRequired": true,
      "isUnique": true
    }
  ],
  "rawSchema": [
    {}
  ],
  "schemaType": "DETAIL",
  "entity": {},
  "isSchemaEditable": true,
  "limit": 123,
  "additionalData": {},
  "dataValidation": {
    "enabled": true
  },
  "linkingColumns": [
    "<string>"
  ],
  "dataLinking": {
    "enabled": true,
    "linkingColumns": [
      "<string>"
    ]
  },
  "validationStatistics": {
    "count": 123,
    "change": 123
  },
  "notificationConfig": {
    "enabled": true,
    "fields": [
      {
        "fieldName": "<string>",
        "operator": "changed"
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication

Path Parameters

workflowId
string
required

ID of the workflow to retrieve

Response

Workflow details retrieved successfully

_id
string

Unique identifier for the workflow

name
string

Name of the workflow

description
string

Description of the workflow

state
enum<string>

Current state of the workflow

Available options:
ACTIVE,
ERROR,
PAUSED,
NOT_SUPPORTED,
PREVIEW,
COMPLIANCE_REVIEW,
COMPLIANCE_REJECTED,
QUEUED,
SETUP,
DELETED
displayState
enum<string>

Display state for frontend

Available options:
ACTIVE,
ERROR,
PAUSED,
NOT_SUPPORTED,
PREVIEW,
COMPLIANCE_REVIEW,
COMPLIANCE_REJECTED,
QUEUED,
SETUP,
RUNNING
userId
string

ID of the user who owns the workflow

createdAt
string<date-time>

Timestamp when the workflow was created

updateInterval
string

Update frequency

schedules
string[]

Cron schedules for updates

nextInvocation
string<date-time>

Next scheduled execution time

monitoring
boolean

Whether monitoring is enabled

location
object

Scraping location configuration

tags
string[]

Tags associated with the workflow

templateName
string

Name of the template used

templateId
string

ID of the template used

jobId
string

ID of the last job

finishedAt
string<date-time>

When the last job finished

startedAt
string<date-time>

When the last job started

protocol
string

Protocol information from last job

dataKey
string

Database key for the workflow data

runCosts
number

Cost of the last job run in credits

runState
string

State of the last job run

totalRecords
integer

Total number of records extracted

url
string

Primary URL being scraped

urls
string[]

List of URLs being scraped

schema
object[]

Extraction schema fields

rawSchema
object[]

Raw schema without processing

schemaType
enum<string>

Type of schema (deprecated)

Available options:
DETAIL,
DIRECTORY
entity
object

Entity information

isSchemaEditable
boolean

Whether the schema can be edited

limit
integer

Maximum number of items to scrape

additionalData
object

Additional static data for the workflow

dataValidation
object

Data validation configuration

linkingColumns
string[]

Columns configured for data linking

dataLinking
object
validationStatistics
object

Validation statistics

notificationConfig
object

Monitoring configuration