Get workflow by ID

Retrieves detailed information about a specific workflow. This endpoint requires authentication and proper team access permissions.

GET /v4/workflows/{workflowId}

Get workflow by ID

cURL

curl --request GET \
  --url https://api.kadoa.com/v4/workflows/{workflowId} \
  --header 'x-api-key: <api-key>'

200

{
  "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>"
    }
  ],
  "navigationMode": "single-page",
  "maxDepth": 100,
  "maxPages": 50000,
  "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
    }
  },
  "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

200

application/json

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

Show child attributes

location. type · enum<string>

Available options: auto, manual

location. isoCode · enum<string>

Available options: DE, US, GB, NL, CA

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

dataKey · string

Database key for the workflow data

errors · object[]

Errors from the last job run

Show child attributes

errors. errorCode · string

Error code identifying the type of error

errors. message · string

Human-readable error message

errors. timestamp · string<date-time>

When the error occurred

errors. screenshot · string

Optional screenshot URL

errors. context · object

Additional context about the error

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

browserActions · object[]

Optional browser actions to perform before extraction

Show child attributes

browserActions. type · string

Action type (e.g., CLICK, TYPE, WAIT, GOTO)

browserActions. selector · string

CSS selector for element-based actions

browserActions. text · string

Text to type for TYPE actions

browserActions. timeMs · integer

Milliseconds to wait for WAIT actions

browserActions. url · string

URL to navigate to for GOTO actions

navigationMode · enum<string>

Navigation mode for scraping. Determines how the scraper navigates through pages

Available options: single-page, paginated-page, page-and-detail, agentic-navigation, all-pages

maxDepth · integer

Maximum crawl depth (default: 50, max: 200). Only used when navigationMode is 'all-pages'

Required range: 1 <= x <= 200

maxPages · integer

Maximum pages to crawl (default: 10,000, max: 100,000). Only used when navigationMode is 'all-pages'

Required range: 1 <= x <= 100000

schema · object[]

Extraction schema fields

Show child attributes

schema. name · string

schema. description · string

schema. example · string

schema. dataType · enum<string>

Available options: STRING, NUMBER, BOOLEAN, DATE, DATETIME, CURRENCY, MONEY, IMAGE, LINK, OBJECT, ARRAY

schema. isKey · boolean

schema. isRequired · boolean

schema. isUnique · boolean

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

Show child attributes

dataValidation. enabled · boolean

Whether data validation is enabled

dataValidation. ruleCounts · object

Counts of validation rules by status

Show child attributes

dataValidation.ruleCounts. enabled · integer

Number of enabled validation rules

dataValidation.ruleCounts. disabled · integer

Number of disabled validation rules

dataValidation.ruleCounts. preview · integer

Number of preview validation rules

validationStatistics · object

Validation statistics

Show child attributes

validationStatistics. count · number

Overall validation score

validationStatistics. change · number

Change in validation score since last validation

notificationConfig · object

Monitoring configuration

Show child attributes

notificationConfig. enabled · boolean

notificationConfig. fields · object[]

Show child attributes

notificationConfig.fields. fieldName · string

notificationConfig.fields. operator · enum<string>

Available options: changed, added, removed