---
title: "Retrieve a Playbook Run"
method: GET
path: "/v2.0/playbooks/{playbookId}/runs/{playbookRunId}"
tags: ["Playbooks"]
---

# Retrieve a Playbook Run

`GET /v2.0/playbooks/{playbookId}/runs/{playbookRunId}`

## Request

- Base URL: `https://api-trial.cognigy.ai/testing`
- URL: `https://api-trial.cognigy.ai/testing/v2.0/playbooks/{playbookId}/runs/{playbookRunId}`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in query parameter `api_key`
  - API key in header `x-cxone-authorization`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Password
    - Token URL: `/auth/oauth2/token`
- TypeScript: <https://skmtc.dev/cognigy/apis/simulator-openapi-rest-ful-api-reference/docs/v2.0/playbooks/:playbookId/runs/:playbookRunId/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves data about a [Playbook run](https://docs.cognigy.com/ai/agents/test/playbooks).

## Path parameters

- `playbookId` string, required
- `playbookRunId` string, required

## Headers

- `Accept` 'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

## Response `200`

Returns Playbook run object

- object: The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.
  - `status` 'successful' | 'failed': Whether the playbook run was successful or failed
  - `_id` string
  - `createdAt` integer: Unix-timestamp
  - `lastChanged` integer: Unix-timestamp
  - `createdBy` string
  - `lastChangedBy` string
  - `stepResults` object[]
    - `status` 'successful' | 'failed': Whether this playbook step was successful or failed
    - `text` string: Text which we shoot into the system
    - `data` object: Data which we shoot into the system
    - `_id` string
    - `asserts` object[]
      - `type` string: Type of the assert
      - `status` 'successful' | 'failed': Whether this playbook step was successful or failed
      - `params` object: Parameters for the assert
      - `negate` boolean: Whether the assert was negated
      - `actual` object: Actual output
      - `_id` string
    - `timeout` boolean: Whether the step timed out
  - `flowId` string: Reference Id of the flow
  - `localeId` string: Reference Id of the locale
  - `entrypoint` string: snapshot or project ID

## Other responses

- `400`: The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)
- `401`: The request has not been applied because it lacks valid authentication credentials for the target resource.
- `402`: Upgrade your Plan to increase your Quota.
- `403`: The server understood the request but refuses to authorize it.
- `404`: The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
- `405`: The method received in the request-line is known by the origin server but not supported by the target resource.
- `409`: The request conflicts with current state of the server.
- `413`: The request entity is larger than limits defined by server.
- `500`: The server encountered an unexpected condition that prevented it from fulfilling the request.
- `501`: The server does not support the functionality required to fulfill the request.
- `502`: The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
- `503`: The server is not ready to handle the request.
- `504`: The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.

---

[API](https://skmtc.dev/cognigy/apis/simulator-openapi-rest-ful-api-reference.md) - [All operations](https://skmtc.dev/cognigy/apis/simulator-openapi-rest-ful-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/cognigy/apis/simulator-openapi-rest-ful-api-reference/revisions/85b2872bdfb7?raw)