> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.withpersona.com/2020-05-18/api-reference/workflows/retrieve-a-workflow-run/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withpersona.com/_mcp/server.

# Retrieve a Workflow Run

GET https://api.withpersona.com/api/v1/workflow-runs/{workflow-run-id}

Retrieves the details of an existing workflow run.

Reference: https://docs.withpersona.com/api-reference/workflows/retrieve-a-workflow-run

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `workflow-run-id` (string, required) — Workflow Run's ID (starts with "wfr_")

### Query parameters

- `include` (string, optional) — A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details.
- `fields` (map from string to string, optional) — Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details.

### Headers

- `Key-Inflection` (enum, optional) — Determines casing for the API response.
  - Allowed values: `camel`, `kebab`, `snake`
- `Idempotency-Key` (string, optional) — Ensures the request is idempotent.
- `Persona-Version` (enum, optional) — Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).
  - Allowed values: `2025-12-08`, `2025-10-27`, `2023-01-05`, `2022-09-01`, `2021-08-18`, `2021-07-05`, `2021-02-21`, `2020-05-18`

## Response

### 200

This endpoint returns a Workflow Run object.

- `data` (workflow-run, required) — A Workflow Run object
- `included` (list of WorkflowRunIncludedObjectsItems, optional) — Objects that _may_ be returned if specified via the `include` query parameter in the request.

## Errors

### 400 Bad Request Error

The request was unacceptable, often due to invalid parameters.

- `errors` (list of WorkflowRunsWorkflowRunIdGetResponsesContentApplicationJsonSchemaErrorsItems, optional)

### 401 Unauthorized Error

An invalid API key was provided.

- `errors` (list of WorkflowRunsWorkflowRunIdGetResponsesContentApplicationJsonSchemaErrorsItems, optional)

### 403 Forbidden Error

The given API key doesn’t have permissions to perform the request or a quota has been exceeded.

- `errors` (list of WorkflowRunsWorkflowRunIdGetResponsesContentApplicationJsonSchemaErrorsItems, optional)

### 404 Not Found Error

The requested resource doesn’t exist.

- `errors` (list of WorkflowRunsWorkflowRunIdGetResponsesContentApplicationJsonSchemaErrorsItems, optional)

### 429 Too Many Requests Error

Your organization’s rate limit has been exceeded. We recommend an exponential backoff on requests.

- `errors` (list of WorkflowRunsWorkflowRunIdGetResponsesContentApplicationJsonSchemaErrorsItems, optional)

## Types

### workflow-run

A Workflow Run object

- `id` (string, optional)
- `attributes` (InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunAttributes, optional)
- `relationships` (InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationships, optional)
- `meta` (InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunMeta, optional)

### WorkflowRunIncludedObjectsItems

- `type`: `workflow` (workflow)
  - `attributes` (WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowAttributes, optional)
  - `id` (string, optional)
  - `relationships` (WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationships, optional)
- `type`: `workflow-version` (workflow-version)
  - `attributes` (WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowVersionAttributes, optional)
  - `id` (string, optional)
  - `relationships` (WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowVersionRelationships, optional)
- `type`: `event` (event)
  - `attributes` (WorkflowRunIncludedObjectsItemsDiscriminatorMappingEventAttributes, optional)
  - `id` (string, optional)
- `type`: `user` (user)
  - `attributes` (WorkflowRunIncludedObjectsItemsDiscriminatorMappingUserAttributes, optional)
  - `id` (string, optional)

### WorkflowRunsWorkflowRunIdGetResponsesContentApplicationJsonSchemaErrorsItems

- `title` (string, optional)
- `details` (string, optional)

### InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunAttributes

- `completed-at` (datetime, optional, nullable)
- `created-at` (datetime, optional)
- `status` (string, optional)

### InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationships

- `creator` (InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreator, optional)
- `workflow` (InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflow, optional)
- `workflow-version` (InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowVersion, optional)

### InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunMeta

- `processing-time-seconds` (double, optional, nullable)

### WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowAttributes

- `status` (string, optional) — The status of the Workflow Possible values: - paused - running - archived Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update.
- `name` (string, optional)
- `created-at` (datetime, optional)

### WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationships

- `latest-published-version` (WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationshipsLatestPublishedVersion, optional) — latest published version
- `active-deployment` (WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationshipsActiveDeployment, optional) — latest active deployment

### WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowVersionAttributes

- `workflow-name` (string, optional, nullable) — The name of the Workflow this version belongs to.
- `description` (string, optional, nullable) — A description of the changes in this version. Draft versions have no description until one is set.
- `status` (string, optional) — The status of the Workflow Version Possible values: - draft - published - archived Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update.
- `trigger-type` (string, optional, nullable) — What starts a run of this version. Null until a trigger is attached. Possible values: - trigger-account - trigger-api - trigger-case - trigger-direct - trigger-event - trigger-recurring - trigger-schedule - trigger-verification Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update.
- `live` (boolean, optional) — Whether this version is running in the environment of the requesting API key or delivering webhook. While a Workflow is being rolled out, two versions are live at once; both report true. Always false while the Workflow itself is paused or archived.
- `rollout-label` (string, optional, nullable) — Which side of a rollout this version serves. Null when the version is not live — including while the Workflow is paused or archived — and for organizations whose deployments do not model a per-version traffic share. Possible values: - treatment - control Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update.
- `rollout-percentage` (integer, optional, nullable) — The share of traffic this version receives in the environment of the requesting API key or delivering webhook. Null when the version is not live — including while the Workflow is paused or archived — and for organizations whose deployments do not model a per-version traffic share.
- `last-updater` (string, optional, nullable) — The email address of the User who last updated this version. Null when the version was last updated by Persona rather than by a member of your organization.
- `inputs` (list of WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowVersionAttributesInputsItems, optional) — The values a run of this version accepts when it is started.
- `outputs` (list of WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowVersionAttributesOutputsItems, optional) — The values a completed run of this version returns.
- `created-at` (datetime, optional)
- `updated-at` (datetime, optional) — When this version was last edited. Does not cover edits to `inputs` or `outputs`; poll those values directly rather than this timestamp to detect input-contract changes.
- `published-at` (datetime, optional, nullable)

### WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowVersionRelationships

- `workflow` (WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowVersionRelationshipsWorkflow, optional)

### WorkflowRunIncludedObjectsItemsDiscriminatorMappingEventAttributes

- `name` (string, optional)
- `payload` (WorkflowRunIncludedObjectsItemsDiscriminatorMappingEventAttributesPayload, optional) — For a Persona-defined event, the entire serialized entity that triggered it. For a custom event, the arbitrary body you supplied when creating it, returned exactly as sent -- its keys are never re-cased.
- `created-at` (datetime, optional)
- `context` (map from string to any, optional) — Additional context populated for some event types.

### WorkflowRunIncludedObjectsItemsDiscriminatorMappingUserAttributes

- `email-address` (string, optional)
- `name-first` (string, optional)
- `name-last` (string, optional)

### InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreator

- `data` (InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData, optional, nullable)

### InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflow

- `data` (InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowData, optional)

### InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowVersion

- `data` (InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowVersionData, optional)

### WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationshipsLatestPublishedVersion

latest published version

- `data` (WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationshipsLatestPublishedVersionData, optional)

### WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationshipsActiveDeployment

latest active deployment

- `data` (workflow-deployment, optional, nullable) — A Workflow Deployment object

### WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowVersionAttributesInputsItems

- `name` (string, optional)
- `type` (string, optional, nullable) — The JSON type accepted for this input.
- `required` (boolean, optional)

### WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowVersionAttributesOutputsItems

- `name` (string, optional, nullable)

### WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowVersionRelationshipsWorkflow

- `data` (WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowVersionRelationshipsWorkflowData, optional)

### WorkflowRunIncludedObjectsItemsDiscriminatorMappingEventAttributesPayload

For a Persona-defined event, the entire serialized entity that triggered it. For a custom event, the arbitrary body you supplied when creating it, returned exactly as sent -- its keys are never re-cased.

- `data` (WorkflowRunIncludedObjectsItemsDiscriminatorMappingEventAttributesPayloadData, optional)

### InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData

### InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowData

- `type` ("workflow", optional)
- `id` (string, optional)

### InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsWorkflowVersionData

- `type` ("workflow-version", optional)
- `id` (string, optional)

### WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowRelationshipsLatestPublishedVersionData

- `type` ("workflow-version", optional)
- `id` (string, optional)

### workflow-deployment

A Workflow Deployment object

- `type` ("workflow-deployment", optional)
- `id` (string, optional)
- `attributes` (WorkflowDeploymentAttributes, optional)

### WorkflowRunIncludedObjectsItemsDiscriminatorMappingWorkflowVersionRelationshipsWorkflowData

- `type` ("workflow", optional)
- `id` (string, optional)

### WorkflowRunIncludedObjectsItemsDiscriminatorMappingEventAttributesPayloadData

- `type` (string, optional)
- `id` (string, optional)
- `attributes` (map from string to any, optional)
- `relationships` (map from string to any, optional)

### InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData0

- `type` ("administrator", optional)
- `id` (string, optional)

### InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData1

- `type` ("user", optional)
- `id` (string, optional)

### InquiryIncludedObjectsItemsDiscriminatorMappingWorkflowRunRelationshipsCreatorData2

- `type` ("event", optional)
- `id` (string, optional)

### WorkflowDeploymentAttributes

- `status` (string, optional) — The status of the Workflow Deployment Possible values: - active - inactive Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update.
- `configuration` (WorkflowDeploymentAttributesConfiguration, optional) — The deployment configuration containing version information
- `created-at` (datetime, optional)
- `updated-at` (datetime, optional)

### WorkflowDeploymentAttributesConfiguration

The deployment configuration containing version information

- `versions` (list of WorkflowDeploymentAttributesConfigurationVersionsItems, optional)

### WorkflowDeploymentAttributesConfigurationVersionsItems

- `token` (string, optional) — The token of the workflow version
- `percentage` (integer, optional) — The percentage of traffic this version should receive
- `label` (string, optional) — The label of the version (treatment or control)

## Examples

**Response**

```json
{
  "data": {
    "id": "wfr_3JqAR9ddLRVZLK5z4yD8oeHB",
    "attributes": {
      "completed-at": null,
      "created-at": "2022-08-08T18:55:44.910Z",
      "status": "in_progress"
    },
    "relationships": {
      "creator": {
        "data": null
      },
      "workflow": {
        "data": {
          "type": "workflow",
          "id": "wfl_3VghhbvDc7UuUNT8uZrqZjsk"
        }
      },
      "workflow-version": {
        "data": {
          "type": "workflow-version",
          "id": "wfv_DkWeGvK9wojQnubF8ABHzJRQ"
        }
      }
    },
    "type": "workflow-run"
  }
}
```

**SDK Code**

```python Success
import requests

url = "https://api.withpersona.com/api/v1/workflow-runs/workflow-run-id"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Success
const url = 'https://api.withpersona.com/api/v1/workflow-runs/workflow-run-id';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Success
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withpersona.com/api/v1/workflow-runs/workflow-run-id"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Success
require 'uri'
require 'net/http'

url = URI("https://api.withpersona.com/api/v1/workflow-runs/workflow-run-id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Success
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.withpersona.com/api/v1/workflow-runs/workflow-run-id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Success
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.withpersona.com/api/v1/workflow-runs/workflow-run-id', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Success
using RestSharp;

var client = new RestClient("https://api.withpersona.com/api/v1/workflow-runs/workflow-run-id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Success
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.withpersona.com/api/v1/workflow-runs/workflow-run-id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```