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

# Get a Playbook

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

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

## Path parameters

- `playbookId` string, required

## Headers

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

## Response `200`

Playbook object retrieved.

- 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.
  - `name` string — The name of the Playbook
  - `abortOnError` boolean — Flag whether to stop Playbook execution when an assert-error occurred
  - `timeout` integer — A time (in ms) after which a playbook step is 'invalid/failed'
  - `_id` string
  - `createdAt` integer — Unix-timestamp
  - `lastChanged` integer — Unix-timestamp
  - `createdBy` string
  - `lastChangedBy` string
  - `steps` object[]
    - `text` string — The text of the playbook step
    - `data` object — The data of this playbook step
    - `_id` string
    - `asserts` object[]
      - `type` 'assertText' | 'assertData' | 'assertState' | 'assertContext' | 'assertIntent' | 'assertSlot' — The type of the Assert
      - `params` object
      - `_id` string

## 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.net/cognigy/apis/simulator-openapi-rest-ful-api-reference.md) · [All operations](https://skmtc.net/cognigy/apis/simulator-openapi-rest-ful-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cognigy/simulator-openapi-rest-ful-api-reference/versions/85b2872bdfb7/schema)