Get workflow by ID
Retrieves detailed information about a specific workflow. This endpoint requires authentication and proper team access permissions.
Authorizations
API key for authentication
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 workflow lifecycle state. DRAFT = workflow exists but setup is incomplete, ACTIVE = workflow is enabled, PAUSED = user paused it, DELETED = soft deleted.
ACTIVE, DRAFT, ERROR, PAUSED, NOT_SUPPORTED, PREVIEW, COMPLIANCE_REVIEW, COMPLIANCE_REJECTED, QUEUED, SETUP, DELETED Computed status shown to users. Combines state + runState. DRAFT = workflow exists but setup is incomplete, ACTIVE = complete/scheduled, RUNNING = job in progress, VALIDATING = run is held for QA review before data delivery, FAILED = last run failed, DEGRADED = monitor experiencing issues (15-60 min stale).
ACTIVE, DRAFT, ERROR, PAUSED, NOT_SUPPORTED, PREVIEW, QUEUED, SETUP, PENDING_START, RUNNING, VALIDATING, FAILED, DEGRADED, COMPLIANCE_REVIEW, COMPLIANCE_REJECTED, DELETED ID of the user who owns the workflow
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
"America/New_York"
Next scheduled execution time
Whether monitoring is enabled
Scraping location configuration
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 this workflow has schema validation rules
Notification channel counts grouped by channel type
ID of the last job
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
Errors from the last job run
Cost of the last job run in credits
Latest job execution state. RUNNING = job in progress, FINISHED = completed successfully, FAILED = job failed.
RUNNING, FINISHED, FAILED Total number of records extracted
Primary URL being scraped
List of URLs being scraped
Optional browser actions to perform before extraction
Maximum crawl depth (default: 50, max: 200).
1 <= x <= 200Maximum pages to crawl (default: 10,000, max: 100,000).
1 <= x <= 100000Extraction schema fields
Canonical extracted entity name
Canonical extraction intent for Assistant-built workflows
Whether batch workflow data predates the current canonical configuration/build
Whether the schema can be edited
Maximum number of items to scrape
Additional static data for the workflow
Data validation configuration
Validation statistics
Current monitoring configuration. Use these values as the basis for replacement updates.
List of open support requests for this workflow. Only present when there are open requests.
Health status for REAL_TIME observer workflows. Only present when health monitoring is active and detects issues.
Customer-safe extraction strategy for custom SCRIPT workflows without an Assistant build. Omitted for Assistant-owned workflows, whose current strategy is available from the Agent strategy endpoint.
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.
Status of the linked assistant session. Useful for deciding whether the Assistant can accept new input (failed/errored/aborted/timed_out are closed).
pending, created, active, idle, inactive, failed, interrupted, errored, aborted, timed_out