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>",
      "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",
      "protocol": "<string>",
      "jobId": "<string>",
      "dataKey": "<string>",
      "location": {
        "type": "auto",
        "isoCode": "DE"
      },
      "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
        }
      ],
      "schemaType": "DETAIL",
      "templateName": "<string>",
      "templateId": "<string>",
      "isSchemaEditable": true,
      "dataValidationEnabled": true,
      "validationStatistics": {
        "totalScore": {
          "slope": 123,
          "average": 123,
          "min": 123,
          "max": 123,
          "change": 123,
          "count": 123
        }
      },
      "monitoring": true,
      "notificationConfig": {
        "enabled": true,
        "fields": [
          {
            "fieldName": "<string>",
            "operator": "changed"
          }
        ],
        "channels": [
          {
            "type": "EMAIL",
            "emails": [
              "<string>"
            ]
          }
        ]
      }
    }
  ],
  "pagination": {
    "totalCount": 123,
    "page": 123,
    "totalPages": 123,
    "limit": 123
  }
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
search
string

Search term to filter workflows by name or URL

​
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

​
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)

Response

200
application/json

Successfully retrieved workflows

The response is of type object.