Skip to main content
GET
Get workflow input schema
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/workflows/get-input-schema?id=<workflowId>[&versionId=<versionId>] Returns the workflow’s active-version input contract, or with versionId that published version’s contract (the form for re-running a specific version), — used by typed dispatch UIs (Slack /workflow slash command, Console dispatch dialog) and by typed clients that want to validate inputs before calling dispatch.

Authentication

External App credential. Requires permission workflows:read.

Query parameters

string
required
The workflow ID.
string
A published version of the workflow (active or superseded). A version that is not this workflow’s answers 404 Workflow version not found; a repeated or empty versionId answers 400.
Breaking change, 2026-08-09. The legacy workflowInputs blob is no longer returned. Read workflowInputSchema, the typed array, as the only representation of the input contract.

Response shape

workflowInputSchema is the input contract. It is a typed array, so field order is preserved across the wire, and there is no second representation to reconcile against.

Responses

string
The workflow ID echoed from the query.
number | null
The active version number (with versionId, that version’s number), or null when the workflow has no active version (UI should fall back to a workflow-select-only state). Also the discriminator for the two workflowInputSchema: null states below.
object[] | null
The input contract, in the typed-array shape. Each entry declares name, type, required, plus optional default, description, validation, derived, asset, and defaultExpr.An empty array means the active version declares no inputs. null means the contract could not be read, and version says why:
  • version: null — the workflow has no active version. Fall back to a workflow-select-only state; dispatch is refused until someone publishes a draft.
  • version: <number> — an active version exists but its contract is unreadable. Do not offer dispatch: POST /api/v2/workflows/dispatch answers 503 for this workflow. Surface “this workflow must be republished” instead.
It never means “the contract lives somewhere else” — there is nowhere else for it to live.

Removed fields

removed
The legacy untyped blob (Record<name, field>) was removed on 2026-08-09. It is absent from the response — not null. A caller that reads it gets undefined; migrate to workflowInputSchema.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

workflowId
string
required

Workflow document id.

Query Parameters

versionId
string

A published version of the workflow (active or superseded).

Minimum string length: 1

Response

Input schema for the workflow's active (or named) version.

data
object
required
meta
object
required