Get a workflow version

GET

https://api.respan.ai/api/workflows/:workflow_id/versions/:version/

GET

/api/workflows/:workflow_id/versions/:version/

$ curl https://api.respan.ai/api/workflows/workflow_id/versions/1/ \
>      -H "Authorization: Bearer <respanApiKey>"

1 {
2   "id": "string",
3   "workflow_id": "string",
4   "version": 1,
5   "type": "automations",
6   "is_enabled": true,
7   "is_read_only": true,
8   "tasks": [
9     {
10       "type": "string",
11       "id": "string",
12       "label": "string",
13       "next": "string",
14       "config": {}
15     }
16   ],
17   "name": "string",
18   "description": "string",
19   "version_description": "string",
20   "trigger_event_type": "request_log",
21   "schedule_cron": "*/15 * * * *",
22   "is_starred": false,
23   "is_public": true,
24   "unique_organization_id": "string",
25   "has_async_steps": true,
26   "created_at": "2024-01-15T09:30:00Z",
27   "updated_at": "2024-01-15T09:30:00Z",
28   "deployed_version": 1,
29   "tags": [
30     {
31       "id": "string",
32       "name": "string",
33       "color": "string",
34       "created_at": "2024-01-15T09:30:00Z",
35       "updated_at": "2024-01-15T09:30:00Z"
36     }
37   ],
38   "graph": {
39     "node_count": 1,
40     "edge_count": 1,
41     "entry_nodes": [
42       "string"
43     ],
44     "terminal_nodes": [
45       "string"
46     ],
47     "nodes": {}
48   },
49   "has_write_access": true
50 }

Retrieve one exact workflow version, including its current write-access metadata.

Authentication

AuthorizationBearer

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.

AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

Path parameters

workflow_idstringRequired

Logical workflow-family ID.

versionintegerRequired

Workflow version number.

Response

Workflow version.

idstringRead-only

workflow_idstringRead-only

versionintegerRead-only

typeenumDefaults to automations

Workflow category. Defaults to automations.

is_enabledbooleanRead-only

is_read_onlybooleanRead-only

taskslist of objects

namestring or nullOptional

descriptionstring or nullOptional

version_descriptionstringOptionalRead-only

Commit message for this version. Set only through the commit endpoint.

trigger_event_typeenum or nullOptional

Event that triggers the workflow. Use scheduled with schedule_cron.

schedule_cronstring or nullOptional

UTC five-field cron expression. Required when trigger_event_type is scheduled, forbidden for other trigger types, and limited to a minimum five-minute cadence. Timezone prefixes such as TZ and CRON_TZ are not supported.

is_starredbooleanOptionalDefaults to false

is_publicbooleanOptionalRead-only

unique_organization_idstring or nullOptionalRead-only

has_async_stepsbooleanOptionalRead-only

created_atdatetimeOptionalRead-only

updated_atdatetimeOptionalRead-only

deployed_versioninteger or nullOptionalRead-only

tagslist of objectsOptionalRead-only

graphobject or nullOptionalRead-only

has_write_accessbooleanOptionalRead-only

Whether the authenticated caller may edit this workflow family.

Errors

401

Unauthorized Error

404

Not Found Error