Skip to main content
GET
Get where a run came from
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

Returns whether the run is a production or a test run, its workflowId, the published version it ran (id, number, active or superseded, publish time), its currentAttempt and every attempt it has made (attempts, ascending). A test run ran a draft and has no version.

The workflow’s authoring data

workflow (the workflow’s id and name) and draft (the draft a test run ran, with the version it was based on) belong to the workflow, so they are null unless your scopes also reach workflows:read and your role grants hold it at the workflow’s home. That is never a refusal: the rest of the answer is the same.

Visibility

You need runs:read at the run’s home (its own org unit, else its workflow’s owning org unit) and at every company it carries, the same rule as GET /api/v2/runs/get. Any other run, and a run with neither home, answers 404 “Run not found” like a missing one. A Personal key reads as its owner, cut down to the key’s scopes; an External App reads by its own role grants. id is required; a missing id answers 404, like GET /api/v2/runs/get.

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

runId
string
required

The run id.

Minimum string length: 1

Response

The run's provenance

data
object
required
meta
object
required