Skip to main content
GET
You can specify multiple query parameters, for example ?source_id=<connector-id>&status=<status>.

Query parameters

source_id
string
Filter by source connector ID.
destination_id
string
Filter by destination connector ID.
status
string
Filter by workflow state.
name
string
Filter by workflow name.
page
integer
Page number for pagination. Default: 1.
page_size
integer
Results per page. Default: 20.
created_since
string
Return workflows created after this ISO 8601 timestamp.
created_before
string
Return workflows created before this ISO 8601 timestamp.
sort_by
string
Field to sort results by. Default: id.
sort_direction
string
Sort order. Default: asc.
dag_node_configuration_id
string
Filter by DAG node configuration ID.
show_only_soft_deleted
boolean
If true, return only soft-deleted workflows. Default: false.
show_recommender_workflows
boolean
If true, include recommender system workflows. Default: false.

Response

id
string
required
Unique identifier for the workflow.
name
string
required
Workflow name.
workflow_type
string
required
Workflow type: custom or auto.
status
string
required
Workflow state: active, inactive, or paused.
created_at
string
required
ISO 8601 timestamp when the workflow was created.
source_id
string
Source connector ID.
destination_id
string
Destination connector ID.
schedule
string
Repeating run schedule.
dag_nodes
array
Workflow processing pipeline nodes.For more information on workflow nodes, see Workflow nodes.
updated_at
string
ISO 8601 timestamp when the workflow was last updated.