Skip to main content
GET
Get a published version's preview options
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/getDebugPreviewOptions Returns a published version’s nodes and its newest completed or failed production runs, for previewDebugSlice. A published preview is not personal: it reads a version, not an attempt. A graph over the preview limit is a 409.

Authentication

Personal key, External App credential or platform API key. Requires permission workflows:use, and the credential’s scopes must also reach workflows:read; both are decided at the version’s workflow’s home org unit. When draft debugging (workflow_debug_execution) is off, the route answers 409 conflict.

Query parameters

string
required
The workflow version’s id.

Responses

200 with data.versionId, data.workflowId, data.workflowName, data.versionNumber, data.nodes, data.sourceRuns and data.sourceScanExhausted.

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

The workflow version's id. Give it exactly once.

Minimum string length: 1

Response

The version's preview options

data
object
required
meta
object
required