GET
/
v4
/
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",
      "isAdvanced": true,
      "limit": 123,
      "finishedAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "protocol": "<string>",
      "dataKey": "<string>",
      "location": {
        "type": "auto",
        "isoCode": "DE"
      },
      "runCosts": 123,
      "runState": "<string>",
      "totalRecords": 123,
      "url": "<string>",
      "schema": {},
      "schemaType": "DETAIL",
      "templateName": "<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
​
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

Response

200
application/json
Successfully retrieved workflows
​
workflows
object[]
​
pagination
object
Get workflow data by IDGet workflow by ID