---
title: "GET /workflowruns/{workflowRunId}"
method: GET
path: "/workflowruns/{workflowRunId}"
tags: ["WorkflowRuns"]
---

# GET /workflowruns/{workflowRunId}

`GET /workflowruns/{workflowRunId}`

Get a workflow run.

## Path parameters

- `workflowRunId` string, uuid, required

## Query parameters

- `api-version` string, required

## Response `200`

OK

- WorkflowRun — The execution of a workflow. It includes workflow action DAG at run time (action DAG snapshot), run payload, status of the entire run and other properties of a run.
  - `id` string, uuid — The workflow run id.
  - `workflowId` string, uuid — The workflow id.
  - `startTime` string, date-time — Workflow run start time.
  - `requestor` string, uuid — The person who submitted the user request.
  - `userRequestId` string, uuid — The user request id.
  - `runPayload` object — The input of a workflow run. Align with operation in user request.
    - `type` 'CreateTerm' | 'UpdateTerm' | 'DeleteTerm' | 'ImportTerms' | 'UpdateAsset' | 'GrantDataAccess', required — The workflow run payload type.
    - `targetValue` string, required — The target value which need involve workflow to update.
    - `payload` object, required — The payload of each operation which user want to submit.
  - `status` 'NotStarted' | 'InProgress' | 'Failed' | 'Completed' | 'Canceling' | 'CancellationFailed' | 'Canceled' — The status.
  - `endTime` string, date-time — The time of workflow run completed.
  - `cancelTime` string, date-time — The time of workflow run be canceled.
  - `cancelComment` string — The comment when cancel a workflow run.
  - `actionDag` object, required — The action DAG(Directed Acyclic Graph), it defines actual flow.
  - `detail` WorkflowRunDetail, required — It refers to the "detail" property of a workflow run object, which contains run context and runtime information of actions.
    - `runInput` object, required — Built-in variables starts with @runInput. Its properties are determined by trigger type at workflow run time.
    - `actions` object, required

## Other responses

- `default` — Error response describing why the operation failed.

## Changes

- **2026-07-13** (2022-05-01-preview) `60435bfd503d` — 1 info
  - api operation id `GetWorkflowRun` removed and replaced with `WorkflowRun_Get`

[Change history](https://skmtc.dev/azure/apis/purview-workflow/changes/workflowruns/:workflowRunId/get.md)

---

[API](https://skmtc.dev/azure/apis/purview-workflow.md) · [All operations](https://skmtc.dev/azure/apis/purview-workflow/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/purview-workflow/revisions/60435bfd503d/schema)