Skip to main content
GET
Get workflow

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project slug, UUID, or domain that identifies the project.

workflow_id
string
required

Workflow identifier

Query Parameters

runtime_target_kind
enum<string> | null
Available options:
main_branch,
environment,
preview_branch,
null
target_environment_id
string<uuid> | null
target_branch_id
string<uuid> | null
source_target_kind
enum<string>
Available options:
project,
main_branch,
environment,
preview_branch

Response

Discovered project workflow

Workflow definition returned by MCP workflow tools.

id
string
required

Workflow identifier.

name
string
required

Human-readable workflow name.

description
string | null
required

Short description of the workflow purpose.

target
string
required

Execution target that implements the workflow.

source_path
string
required

Source file path where the workflow definition lives.

edit_mode
enum<string>
required

Editing mode supported for the workflow definition; source_only definitions reject update_workflow with source_only_conflict.

Available options:
structured,
source_only
version
string | null
required

Version string for the workflow definition, when tracked.

input_schema
object | null
required

Structured input schema for workflow execution, when defined.

output_schema
object | null
required

Structured output schema for workflow execution, when defined.

schedulable
boolean
required

Whether the workflow can be triggered by schedulers or automations.