Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
workflows

Get Workflow Version

Get or edit a specific workflow version.

GET /api/workflows/{workflow_id}/versions/{version}/ PATCH /api/workflows/{workflow_id}/versions/{version}/ (only if is_read_only=False)

PUBLIC workflow versions are readable by every tenant; PATCH scopes to own rows only, so a public version 404s for non-staff instead of resolving into a mutation path.

get/api/workflows/{workflow_id}/versions/{version}/

Path parameters

versioninteger required
workflow_idstring required

Headers

Authorizationstring required

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

Response

idstring
workflow_idstring

Logical workflow family key shared across versions

versioninteger
namestring nullable
descriptionstring nullable
type'automations' | 'monitors' | 'evaluators' | 'reports' | 'exports' | 'ingests'
  • automations - Automation
  • monitors - Monitor
  • evaluators - Evaluator
  • reports - Report
  • exports - Export
  • ingests - Ingest
schedule_cronstring nullable

UTC cron schedule (5-field). Populated when trigger_event_type='scheduled'.

is_enabledboolean required
is_starredboolean
is_read_onlyboolean

True for committed versions; only the latest version is editable

is_publicboolean required
unique_organization_idstring required
tasksWorkflowDetailTasksItems[] required
has_async_stepsboolean
created_atstring date-time required
updated_atstring date-time required
deployed_versioninteger nullable required