Get workflow by ID
Retrieves detailed information about a specific workflow. This endpoint requires authentication and proper team access permissions.
Request
- Base URL: https://api.kadoa.com
- URL: https://api.kadoa.com/v4/workflows/{workflowId}
- Auth: API key in header x-api-key
Path parameters
ID of the workflow to retrieve
Response
Workflow details retrieved successfully
Unique identifier for the workflow
Name of the workflow
Description of the workflow
Persisted state of the long-lived workflow. It may describe setup or a control state such as ACTIVE or PAUSED. Use displayState for operational status UI.
Computed operational summary based on workflow state, the latest run, and monitor health. It does not indicate pending user input or support ownership; use awaitingUserInput and inSupport for those. ACTIVE may be presented as Complete, Scheduled, or Running depending on workflow type and schedule.
Why the latest run is being verified. Only present while displayState is VALIDATING.
ID of the user who owns the workflow
Display name of the workflow owner
Email of the workflow owner
Timestamp when the workflow was created
Update frequency
Whether this workflow should be displayed as realtime
Most recent persisted customer-visible data change for a real-time workflow
Cron schedules for updates
IANA timezone used to evaluate cron schedules
Next scheduled execution time
Whether monitoring is enabled
Tags associated with the workflow
Name of the schema used
ID of the schema used
Name of the linked workflow template
ID of the linked workflow template
Applied template version
Whether the template controls the workflow prompt
Whether the template controls the extraction schema
Whether the template controls schema validation rules
Whether the template controls notification settings
Whether the template controls schedule/frequency
Whether the template controls the output record limit
Whether this workflow has schema validation rules
Notification channel counts grouped by channel type
ID of the latest operational run attempt
ID of the latest finished run that supplies customer-visible data
Whether the workflow has not completed a regular run yet
Number of data-quality issues in the latest finished run
When the last job finished
When the last job started
Estimated UTC finish time for the active job, when available.
Database key for the workflow data
State of the latest execution attempt. Use this for run diagnostics or workflow history, not as the workflow lifecycle or status label.
Total number of records extracted
Primary URL being scraped
List of URLs being scraped
Canonical extracted entity name
Canonical extraction intent for Assistant-built workflows
Whether the schema can be edited
Maximum number of items to scrape
Additional static data for the workflow
True when Kadoa support has an open ticket on this workflow. Same predicate as the inSupport query filter. Independent of state/displayState: this answers who is handling the workflow, while displayState answers whether it is delivering data. Prefer this over recomputing from openSupportRequests.
Newest assistant session linked to this workflow, regardless of status. Null if no assistant session has been created for this workflow.
Newest assistant thread within the assistant session.
True when this workflow's lane supports the assistant (SHELLY_SCRIPT or SHELLY_REAL_TIME_SCRIPT). Independent of assistantSessionId; combine with !assistantSessionId for start-vs-continue.
Current workspace execution lane, independent of preview readiness.
Low-level status of the latest Assistant conversation. Use it only to decide whether that conversation can accept input. Do not infer workflow progress or whether a reply is needed; use displayState and awaitingUserInput instead.
Example response
{
"scheduleTimezone": "America/New_York"
}Changes
No recorded changes to this operation across all 1 revision of this API.