Skip to main content
GET
/
v4
/
workflows
Get a list of workflows
curl --request GET \
  --url https://api.kadoa.com/v4/workflows \
  --header 'x-api-key: <api-key>'
{
  "workflows": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "openSupportRequests": [
        {
          "issueId": "<string>",
          "requestedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "userId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updateInterval": "<string>",
      "isRealTime": true,
      "tags": [
        "<string>"
      ],
      "limit": 123,
      "finishedAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "estimatedFinishedAtUtc": "2023-11-07T05:31:56Z",
      "jobId": "<string>",
      "dataKey": "<string>",
      "location": {},
      "runCosts": 123,
      "totalRecords": 123,
      "url": "<string>",
      "urls": [
        "<string>"
      ],
      "browserActions": [
        {
          "type": "<string>",
          "selector": "<string>",
          "text": "<string>",
          "timeMs": 123,
          "url": "<string>"
        }
      ],
      "maxDepth": 100,
      "maxPages": 50000,
      "schema": [
        {
          "name": "<string>",
          "description": "<string>",
          "example": "<string>",
          "isKey": true,
          "isRequired": true,
          "isUnique": true
        }
      ],
      "schemaName": "<string>",
      "schemaId": "<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>"
          }
        ]
      },
      "observerHealth": {
        "reason": "<string>",
        "issueStartedAt": "2023-11-07T05:31:56Z",
        "lastCheckedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "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 persisted workflow state. DRAFT workflows are excluded from default results unless explicitly requested. Use inSupport param to filter by support status.

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

Filter workflows by latest job run state (e.g., FAILED)

Available options:
FAILED,
FINISHED,
RUNNING
​
displayState
enum<string>

Filter workflows by computed display state (comma-separated for multiple)

Available options:
ACTIVE,
DRAFT,
PAUSED,
PREVIEW,
FAILED,
RUNNING,
VALIDATING,
PENDING_START,
COMPLIANCE_REVIEW,
COMPLIANCE_REJECTED
​
inSupport
enum<string>

Filter workflows by support status (has open support request)

Available options:
true,
false
​
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
​
scheduleType
enum<string>

Filter workflows by schedule type. RUN_ONCE = no recurring schedule (Complete), RECURRING = has a recurring/real-time schedule (Scheduled).

Available options:
RUN_ONCE,
RECURRING
​
includeDeleted
enum<string>
default:false

Include deleted workflows (for compliance officers)

Available options:
true,
false
​
format
enum<string>
default:json

Response format (json or csv for export)

Available options:
json,
csv

Response

Successfully retrieved workflows

​
workflows
object[]

List of workflows

​
pagination
object

Pagination information