Skip to main content
GET
Get a workflow run

Authorizations

Authorization
string
header
required

Workspace credential issued from the automation console at /automation. Send it as Authorization: Bearer vq_ws_.... This is NOT a Data API key: a vq_key_ credential is refused here and names the other product in the error.

Path Parameters

matterId
string
required

mat_ identifier of the matter to work inside. Everything in this API hangs off a matter, and the matter in the path is what the authorization boundary is checked against. Take it from GET /v1/matters.

runId
string
required

wfr_ identifier of one workflow RUN. Returned on the operation that launched it, and distinct from the workflowId that was run.

Response

Successful Response

One run. status is the public five, never the stored spelling.

The internal vocabulary has eight values, five of which (preparing, extracting, synthesizing, rendering, plus pending) describe a stage rather than an outcome. Those read as running, and progressPercent is what carries how far along it is.

id
string
required

Public identifier, wfr_ followed by 32 hex characters.

Example:

"wfr_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

matterId
string
required

mat_ identifier of the matter this run belongs to.

Example:

"mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

workflowId
string
required

Identifier of the workflow definition that was run.

Example:

"contract-diligence"

title
string
required

Display title for the run.

Example:

"Diligence pass, Acme"

status
enum<string>
required

Run status, using the same five public values as an operation. The internal stage vocabulary (preparing, extracting, synthesizing, rendering) all reads as running.

Available options:
queued,
running,
succeeded,
failed,
cancelled
Example:

"succeeded"

progressPercent
integer
required

How far along the run is, 0 to 100. This is what carries progress, since the stages all collapse to running.

Example:

100

createdAt
string<date-time>
required

When the run was created (RFC 3339).

Example:

"2026-08-19T14:32:10Z"

updatedAt
string<date-time>
required

When the run was last updated (RFC 3339).

Example:

"2026-08-19T14:32:10Z"

progressMessage
string | null

Short human-readable stage label, for example 'synthesizing findings'. Free text for a progress line only. Never branch on it; branch on status.

Example:

"synthesizing findings"

artifacts
WorkflowArtifact · object[]

Deliverables produced so far. Listing is separate from downloading, so that a URL cannot be minted for an installation revoked between the two calls.

startedAt
string<date-time> | null

When the run began executing (RFC 3339).

Example:

"2026-08-19T14:32:10Z"

completedAt
string<date-time> | null

When the run reached a terminal status (RFC 3339).

Example:

"2026-08-19T14:32:10Z"

Last modified on August 23, 2026