workflows

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.

get/api/workflows/{workflow_id}/

Path parameters

workflow_idstring required

Logical workflow-family ID.

Query parameters

is_including_secretsboolean

Reveal webhook secret values when authorized.

is_exportingboolean

Return a portable export envelope.

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

Workflow detail or portable export.

OR

Changes

Changed in 2 of the 6 revisions of this API.5177

  • 4e064cf81dae33See the full diff
    • for the query request parameter is_exporting, default value false was added

      request-parameter-default-value-added

    • for the query request parameter is_including_secrets, default value false was added

      request-parameter-default-value-added

    • added WorkflowsGetWorkflowResponse2000 WorkflowsGetWorkflowResponse2001 to the response body oneOf list for the response status 200

      response-body-one-of-added

    • removed WorkflowDetail WorkflowExport from the response body oneOf list for the response status 200

      response-body-one-of-removed

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 404

      response-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

  • c26d550029f82174See the full diff
    • added WorkflowDetail WorkflowExport to the response body oneOf list for the response status 200

      response-body-one-of-added

    • the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • removed the optional property created_at from the response with the 200 status

      response-optional-property-removed

    • removed the optional property deployed_version from the response with the 200 status

      response-optional-property-removed

    • removed the optional property description from the response with the 200 status

      response-optional-property-removed

    • removed the optional property graph from the response with the 200 status

      response-optional-property-removed

    • removed the optional property has_async_steps from the response with the 200 status

      response-optional-property-removed

    • removed the optional property id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property is_enabled from the response with the 200 status

      response-optional-property-removed

    • removed the optional property is_read_only from the response with the 200 status

      response-optional-property-removed

    • removed the optional property is_starred from the response with the 200 status

      response-optional-property-removed

    • removed the optional property name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property tasks from the response with the 200 status

      response-optional-property-removed

    • removed the optional property trigger_event_type from the response with the 200 status

      response-optional-property-removed

    • removed the optional property type from the response with the 200 status

      response-optional-property-removed

    • removed the optional property updated_at from the response with the 200 status

      response-optional-property-removed

    • removed the optional property version from the response with the 200 status

      response-optional-property-removed

    • removed the optional property workflow_activities from the response with the 200 status

      response-optional-property-removed

    • removed the optional property workflow_id from the response with the 200 status

      response-optional-property-removed

    • added the new optional query request parameter is_exporting

      new-optional-request-parameter

    • added the new optional query request parameter is_including_secrets

      new-optional-request-parameter

    • removed the non-success response with the status 401

      response-non-success-status-removed

    • removed the non-success response with the status 404

      response-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