GET
/
v4
/
workflows
/
{workflowId}
curl --request GET \
  --url https://api.kadoa.com/v4/workflows/{workflowId} \
  --header 'x-api-key: <api-key>'
{
  "_id": "<string>",
  "name": "<string>",
  "state": "ACTIVE",
  "displayState": "ACTIVE",
  "userId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updateInterval": "<string>",
  "schedules": [
    "<string>"
  ],
  "nextInvocation": "2023-11-07T05:31:56Z",
  "monitoring": true,
  "location": {
    "type": "auto",
    "isoCode": "DE"
  },
  "tags": [
    "<string>"
  ],
  "templateName": "<string>",
  "templateId": "<string>",
  "jobId": "<string>",
  "finishedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "protocol": "<string>",
  "dataKey": "<string>",
  "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
    }
  ],
  "rawSchema": [
    {}
  ],
  "schemaType": "DETAIL",
  "entity": {},
  "isSchemaEditable": true,
  "limit": 123,
  "additionalData": {},
  "notificationConfig": {
    "enabled": true,
    "fields": [
      {
        "fieldName": "<string>",
        "operator": "changed"
      }
    ],
    "channels": [
      {
        "type": "EMAIL",
        "emails": [
          "<string>"
        ]
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

workflowId
string
required

ID of the workflow to retrieve

Response

200
application/json

Workflow details retrieved successfully

The response is of type object.