Get a workflow

GET

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

GET

/api/workflows/:workflow_id/

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

1 {
2   "id": "string",
3   "workflow_id": "string",
4   "version": 1,
5   "name": "string",
6   "description": "string",
7   "version_description": "string",
8   "type": "automations",
9   "trigger_event_type": "request_log",
10   "schedule_cron": "*/15 * * * *",
11   "is_enabled": true,
12   "is_starred": false,
13   "is_read_only": true,
14   "is_public": true,
15   "unique_organization_id": "string",
16   "has_async_steps": true,
17   "created_at": "2024-01-15T09:30:00Z",
18   "updated_at": "2024-01-15T09:30:00Z",
19   "deployed_version": 1,
20   "tags": [
21     {
22       "id": "string",
23       "name": "string",
24       "color": "string",
25       "created_at": "2024-01-15T09:30:00Z",
26       "updated_at": "2024-01-15T09:30:00Z"
27     }
28   ],
29   "tasks": [
30     {
31       "id": "string",
32       "type": "string",
33       "label": "string",
34       "next": "string",
35       "config": {}
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 }

Return the editable draft when one exists, otherwise the latest committed version. Set is_exporting=true for a portable, secret-sanitized export. Webhook secrets remain masked unless an authorized caller sets is_including_secrets=true.

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.

Query parameters

is_including_secretsbooleanOptionalDefaults to false

Reveal webhook secret values when authorized.

is_exportingbooleanOptionalDefaults to false

Return a portable export envelope.

Response

Workflow detail or portable export.

object

Errors

401

Unauthorized Error

404

Not Found Error