Skip to main content
GET
List a workflow's published versions
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/listVersions?workflowId=<workflowId> Returns one page of a workflow’s published versions, newest first. Each version shows its number, whether it is the active version new runs use or an older superseded one, when it was published and with what note, and the input and runtime contracts frozen at publish. To act on a version, use rollback to make it the active version, resetDraft to reset the draft to it, or retire to stop new launches of the workflow; each requires workflows:manage.

Authentication

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

Query parameters

string
required
The workflow ID.
integer
default:"25"
Versions per page, 1 to 100. A larger value is 400 too_big. Zero, negative, fractional, non-numeric, empty or repeated values answer 400.
string
meta.nextCursor from the previous page.

Paging

Follow meta.nextCursor until meta.hasMore is false. A page shorter than limit does not mean the list is done; read hasMore.

Responses

data is an array of version objects. Each has the fields described in getVersion.

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

workflowId
string
required

Workflow document id.

Minimum string length: 1

Query Parameters

limit
integer
default:25

Versions per page, 1 to 100. A larger value is 400 too_big; zero, negative, fractional, non-numeric, empty or repeated values answer 400 bad_request.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor: meta.nextCursor from the previous page.

Response

Version list

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.