Get a list of workflows

Retrieves a list of workflows with pagination and search capabilities

GET /v4/workflows

Get a list of workflows

cURL

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

200

{
  "workflows": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "state": "ACTIVE",
      "displayState": "ACTIVE",
      "userId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "tags": [
        "<string>"
      ],
      "limit": 123,
      "finishedAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "jobId": "<string>",
      "dataKey": "<string>",
      "location": {
        "type": "auto",
        "isoCode": "DE"
      },
      "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
        }
      ],
      "templateName": "<string>",
      "templateId": "<string>",
      "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"
          }
        }
      ],
      "dataValidation": {
        "enabled": true
      },
      "validationStatistics": {
        "total": {
          "count": 123,
          "change": 123
        },
        "byRule": {
          "ruleName": "<string>",
          "count": 123
        }
      },
      "monitoring": true,
      "notificationConfig": {
        "enabled": true,
        "fields": [
          {
            "fieldName": "<string>",
            "operator": "changed"
          }
        ]
      }
    }
  ],
  "pagination": {
    "totalCount": 123,
    "page": 123,
    "totalPages": 123,
    "limit": 123
  }
}

Authorizations

x-api-key · string · header · required

API key for authentication

Query Parameters

search · string

Search term to filter workflows by name, URL, or workflow ID

skip · integer · default: 0

Number of items to skip

Required range: x >= 0

limit · integer · default: 25

Maximum number of items to return

Required range: x >= 1

state · enum<string>

Filter workflows by state

Available options: ACTIVE, ERROR, PAUSED, NOT_SUPPORTED

tags · string[]

Filter workflows by tags

userId · string

Filter workflows by user ID (team members only)

monitoring · enum<string>

Filter workflows by monitoring status

Available options: true, false

updateInterval · enum<string>

Filter workflows by update interval

Available options: HOURLY, DAILY, WEEKLY, MONTHLY

templateId · string

Filter workflows by template ID (DEPRECATED - templates replaced by schemas)

includeDeleted · enum<string> · default: false

Include deleted workflows (for compliance officers)

Available options: ,

format · enum<string> · default: json

Response format (json or csv for export)

Available options: json, csv

Response

200

application/json

Successfully retrieved workflows

workflows · object[]

List of workflows

Show child attributes

workflows. id · string

Unique identifier for the workflow

workflows. name · string

Name of the workflow

workflows. description · string

Description of the workflow

workflows. state · enum<string>

Current state of the workflow

Available options: ACTIVE, ERROR, PAUSED, NOT_SUPPORTED, PREVIEW, COMPLIANCE_REVIEW, COMPLIANCE_REJECTED, QUEUED, SETUP, DELETED

workflows. displayState · enum<string>

Display state for frontend

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

workflows. userId · string

ID of the user who owns the workflow

workflows. createdAt · string<date-time>

Timestamp when the workflow was created

workflows. tags · string[]

Tags associated with the workflow

workflows. limit · integer

Maximum number of items to scrape

workflows. finishedAt · string<date-time>

When the last job finished

workflows. startedAt · string<date-time>

When the last job started

workflows. jobId · string

ID of the last job

workflows. dataKey · string

Database key for the workflow data

workflows. location · object

Scraping location configuration

Show child attributes

workflows.location. type · enum<string>

Available options: auto, manual

workflows.location. isoCode · enum<string>

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

workflows. runCosts · number

Cost of the last job run in credits

workflows. runState · string

State of the last job run

workflows. totalRecords · integer

Total number of records extracted

workflows. url · string

Primary URL being scraped

workflows. urls · string[]

List of URLs being scraped

workflows. browserActions · object[]

Optional browser actions to perform before extraction

Show child attributes

workflows.browserActions. type · string

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

workflows.browserActions. selector · string

CSS selector for element-based actions

workflows.browserActions. text · string

Text to type for TYPE actions

workflows.browserActions. timeMs · integer

Milliseconds to wait for WAIT actions

workflows.browserActions. url · string

URL to navigate to for GOTO actions

workflows. 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

workflows. maxDepth · integer

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

Required range: 1 <= x <= 200

workflows. maxPages · integer

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

Required range: 1 <= x <= 100000

workflows. schema · object[]

Extraction schema fields

Show child attributes

workflows.schema. name · string

workflows.schema. description · string

workflows.schema. example · string

workflows.schema. dataType · enum<string>

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

workflows.schema. isKey · boolean

workflows.schema. isRequired · boolean

workflows.schema. isUnique · boolean

workflows. templateName · string

Name of the template used

workflows. templateId · string

ID of the template used

workflows. errors · object[]

Errors from the last job run

Show child attributes

workflows.errors. errorCode · string

Error code identifying the type of error

workflows.errors. message · string

Human-readable error message

workflows.errors. timestamp · string<date-time>

When the error occurred

workflows.errors. screenshot · string

Optional screenshot URL

workflows.errors. context · object

Additional context about the error

Show child attributes

workflows.errors.context. url · string

The URL where the error occurred

workflows.errors.context. httpStatus · integer

HTTP status code if applicable

workflows.errors.context. retryCount · integer

Number of retry attempts made

workflows.errors.context. details · string

Additional error-specific details

workflows.errors.context. timestamp · string<date-time>

When the error context was captured

workflows. dataValidation · object

Data validation configuration

Show child attributes

workflows.dataValidation. enabled · boolean

Whether data validation is enabled for the workflow

workflows. validationStatistics · object

Validation statistics for the workflow

Show child attributes

workflows.validationStatistics. total · object

Show child attributes

workflows.validationStatistics.total. count · number

Overall validation score

workflows.validationStatistics.total. change · number

Change in validation score since last validation

workflows.validationStatistics. byRule · object

Show child attributes

workflows.validationStatistics.byRule. ruleName · string

workflows.validationStatistics.byRule. count · number

workflows. monitoring · boolean

Whether monitoring is enabled

workflows. notificationConfig · object

Monitoring configuration

Show child attributes

workflows.notificationConfig. enabled · boolean

workflows.notificationConfig. fields · object[]

Show child attributes

workflows.notificationConfig.fields. fieldName · string

workflows.notificationConfig.fields. operator · enum<string>

Available options: changed, added, removed

pagination · object

Pagination information

Show child attributes

pagination. totalCount · integer

Total number of workflows matching the filter criteria

pagination. page · integer

Current page number

pagination. totalPages · integer

Total number of pages

pagination. limit · integer

Number of items per page