Get a workflow
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.
Path parameters
Logical workflow-family ID.
Query parameters
Reveal webhook secret values when authorized.
Return a portable export envelope.
Headers
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
Workflow detail or portable export.
Changes
Changed in 2 of the 6 revisions of this API.5177
- ▲
for the
queryrequest parameteris_exporting, default valuefalsewas addedrequest-parameter-default-value-added
- ▲
for the
queryrequest parameteris_including_secrets, default valuefalsewas addedrequest-parameter-default-value-added
- ▲
added
WorkflowsGetWorkflowResponse2000WorkflowsGetWorkflowResponse2001to the response bodyoneOflist for the response status200response-body-one-of-added
- ○
removed
WorkflowDetailWorkflowExportfrom the response bodyoneOflist for the response status200response-body-one-of-removed
- ○
added the non-success response with the status
401response-non-success-status-added
- ○
added the non-success response with the status
404response-non-success-status-added
This revision also has 1490 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
added
WorkflowDetailWorkflowExportto the response bodyoneOflist for the response status200response-body-one-of-added
- ▲
the response's body type/format changed from
object/to/for status200response-body-type-changed
- ●
removed the optional property
created_atfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
deployed_versionfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
descriptionfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
graphfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
has_async_stepsfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
idfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
is_enabledfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
is_read_onlyfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
is_starredfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
namefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
tasksfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
trigger_event_typefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
typefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
updated_atfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
versionfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
workflow_activitiesfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
workflow_idfrom the response with the200statusresponse-optional-property-removed
- ○
added the new optional
queryrequest parameteris_exportingnew-optional-request-parameter
- ○
added the new optional
queryrequest parameteris_including_secretsnew-optional-request-parameter
- ○
removed the non-success response with the status
401response-non-success-status-removed
- ○
removed the non-success response with the status
404response-non-success-status-removed
This revision also has 1158 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲