curl --request GET \
--url https://api.kadoa.com/v4/workflows \
--header 'x-api-key: <api-key>'{
"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": "RUNNING",
"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
}
}Retrieves a list of workflows with pagination and search capabilities
curl --request GET \
--url https://api.kadoa.com/v4/workflows \
--header 'x-api-key: <api-key>'{
"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": "RUNNING",
"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
}
}API key for authentication
Search term to filter workflows by name, URL, or workflow ID
Number of items to skip
x >= 0Maximum number of items to return
x >= 1Filter workflows by workflow state
ACTIVE, PAUSED Filter workflows by latest job run state (e.g., FAILED)
FAILED, FINISHED, RUNNING Filter workflows by computed display state (comma-separated for multiple)
ACTIVE, PAUSED, PREVIEW, FAILED, RUNNING, PENDING_START, COMPLIANCE_REVIEW, COMPLIANCE_REJECTED Filter workflows by tags
Filter workflows by user ID (team members only)
Filter workflows by monitoring status
true, false Filter workflows by update interval
HOURLY, DAILY, WEEKLY, MONTHLY Filter workflows by template ID (DEPRECATED - templates replaced by schemas)
Include deleted workflows (for compliance officers)
, Response format (json or csv for export)
json, csv