Skip to main content
GET
Get one published workflow version
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/getVersion?id=<versionId> Returns one published version of a workflow, in the same shape as a listVersions row. Rolling back to a version, resetting the draft to one and retiring a workflow are done by a person in the Forge Console.

Authentication

External App credential or platform API key. Requires permission workflows:read, held at the home org unit of the version’s workflow. The org unit a request acts from is not the workflow’s home.

Query parameters

string
required
The version ID from listVersions. Give it exactly once.

Responses

string
The version’s ID.
string
The workflow ID.
integer
The version number; higher is newer.
string
active for the version new runs use; superseded for every older version.
number
When the version was published, epoch milliseconds.
string
The publisher’s note. Absent when none was given.
object[] | null
The input contract frozen at publish: one object per declared field (name, type, required, and when set default, description, validation, derived, asset, defaultExpr). [] declares no inputs; null means the version recorded no contract.
string
outcomesV1 when the version runs under the outcomes contract. Absent for a legacy version.
The publisher, output settings, notification and output policy, default agents, provisional dependencies, the authoring brief, and vault and credential bindings are never returned.

Errors

Example

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

versionId
string
required

Version id from listVersions. Give it exactly once.

Minimum string length: 1

Response

The version.

data
object
required

One published version of a workflow. No publisher, output, notification, vault, credential, default-agent or brief field is returned. Rollback, reset and retirement have their own operations.

meta
object
required