Sign in
Workflows

Get Workflows

Get all workflows with the latest version for the organization.

Search semantics:

  • If search_key is provided, its value is used as a unified search term for workflows.title, folders.title, and workflow parameter metadata (key, description, and default_value for WorkflowParameterModel).
  • Falls back to deprecated title (title-only search) if search_key is not provided.
  • Parameter metadata search excludes soft-deleted parameter rows across all parameter tables.
get/v1/workflows

Query parameters

pageinteger
page_sizeinteger
only_saved_tasksboolean
only_workflowsboolean
only_templatesboolean
search_keystring nullable

Case-insensitive substring search across: workflow title, folder name, and parameter metadata (key, description, default_value). A workflow is returned if any of these fields match. Soft-deleted parameter definitions are excluded. Takes precedence over the deprecated title parameter.

Example:my_workflow

Case-insensitive substring search across: workflow title, folder name, and parameter metadata (key, description, default_value). A workflow is returned if any of these fields match. Soft-deleted parameter definitions are excluded. Takes precedence over the deprecated title parameter.

titlestring

Deprecated: use search_key instead. Falls back to title-only search if search_key is not provided.

Deprecated: use search_key instead. Falls back to title-only search if search_key is not provided.

folder_idstring nullable

Filter workflows by folder ID

Filter workflows by folder ID

statusWorkflowStatus[] nullable
templateboolean

Headers

x-api-keystring nullable

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Response

Successful Response

workflow_idstring required
organization_idstring required
titlestring required
workflow_permanent_idstring required
versioninteger required
is_saved_taskboolean required
is_templateboolean
descriptionstring nullable
webhook_callback_urlstring nullable
totp_verification_urlstring nullable
totp_identifierstring nullable
persist_browser_sessionboolean
modelobject nullable
status'published' | 'draft' | 'auto_generated' | 'importing' | 'import_failed'
max_screenshot_scrollsinteger nullable
extra_http_headersobject nullable
run_withstring nullable
ai_fallbackboolean
cache_keystring nullable
adaptive_cachingboolean
generate_script_on_terminalboolean
run_sequentiallyboolean nullable
sequential_keystring nullable
folder_idstring nullable
import_errorstring nullable
created_atstring date-time required
modified_atstring date-time required
deleted_atstring date-time nullable

Changes