Sign in

v3

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

Get Workflow

Get, update, or delete a workflow.

Drafts-on-demand resolution:

  • GET returns the draft if one exists, else the latest committed version (404 when the family doesn't exist at all).
  • PATCH edits the draft. When the family has no draft (committed-only), PATCH returns 409 — clients must create a draft first via POST /api/workflows/{workflow_id}/versions/.
  • DELETE removes every version in the family.

Committing a draft is a separate action at POST /api/workflows/{workflow_id}/commits/.

PUBLIC workflows resolve here by id on READS (toggle defaults on so by-id reads stay toggle-free); WRITES scope to own rows only, so a public family 404s for non-staff instead of resolving into a mutation path. JWT writes are additionally gated by check_object_permissions in get_object.

get/api/workflows/{workflow_id}/

Path parameters

workflow_idstring required

Query parameters

is_exportingboolean

Set to true to get a portable export of the workflow. Default: false.

is_including_secretsboolean

Set to true to reveal webhook secret values. Default: false.

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

OR