Documentation
- Introduction
- Workflows
- Schemas
- Real-time Monitors
- Crawling
- Adhoc Extractions
- Credits and Usage
- Workspaces
- Integrations
- Security
- Compliance
- SDKs
API Reference
- Introduction
- Crawling
- Workflows
- Monitoring
- Schemas
- Adhoc
- Events
- Files
- Webhooks
- Locations
Workflows
Get workflow by ID
Retrieves detailed information about a specific workflow. This endpoint requires authentication and proper team access permissions.
GET
/
v4
/
workflows
/
{workflowId}
Copy
curl --request GET \
--url https://api.kadoa.com/v4/workflows/{workflowId} \
--header 'x-api-key: <api-key>'
Copy
{
"_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
Path Parameters
ID of the workflow to retrieve
Response
200
application/json
Workflow details retrieved successfully
The response is of type object
.
Copy
curl --request GET \
--url https://api.kadoa.com/v4/workflows/{workflowId} \
--header 'x-api-key: <api-key>'
Copy
{
"_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>"
]
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.