Skip to main content
GET
Read workflow source

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

source_target_kind
string
target_branch_id
string<uuid> | null
runtime_target_kind
enum<string> | null

Used as the source target kind when source_target_kind is omitted.

Available options:
main_branch,
environment,
preview_branch,
null
target_environment_id
string<uuid> | null

Not supported for source reads; a non-null value is rejected.

Response

Workflow document

Workflow definition including editable source content.

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.

source
string
required

Workflow source code or structured document content.

version
string | null
required

Version string for the workflow definition, when tracked.

schedulable
boolean
required

Whether the workflow can be triggered by schedulers.

edit_mode
enum<string>
required

Editing mode supported for the workflow definition.

Available options:
structured,
source_only
source_only_reasons
string[]
required

Reasons why the workflow can only be edited as raw source, when applicable.