---
title: "Playbook results"
method: GET
path: "/contracts/{contract-id}/playbook-detail"
---

# Playbook results

`GET /contracts/{contract-id}/playbook-detail`

## Request

- Base URL: `https://api.termscout.com`
- URL: `https://api.termscout.com/contracts/{contract-id}/playbook-detail`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/termscout/apis/termscout-data/docs/contracts/:contract-id/playbook-detail/get.ts> (a function with typed inputs; its response is checked against the schema)

Fetch details of playbook results applied to the given contract

## Path parameters

- `contract-id` string, required

## Query parameters

- `filter-id` string

## Response `200`

200 response

- PlaybookDetail: Detailed reasons why a playbook question failed
  - `tier` number: Tier level of the question. Lower number tiers have a greater influence on score.
  - `issue_number` string: Numerical ordering of clauses, grouped by tiers
  - `filter_question_id` number: ID of the filter question
  - `question_id` number: ID of the question
  - `display_name` string: Display name of the filter question
  - `answer_display` string: Short answer if question was addressed in contract. Can be `Yes`, `No`, `N\A` or `Null`
  - `filter_passed` boolean: Result if the contract passed the filter question
  - `footnote` string: Footnotes to the customer
  - `rank` number: Rank
  - `citation` string: Citation to the contract contract that refers to this question
  - `selected_label_ids` number[]: DEPRECATED
  - `unselected_label_ids` number[]: DEPRECATED
  - `required_label_ids` number[]: DEPRECATED
  - `acceptable_label_ids` number[]: DEPRECATED
  - `unacceptable_label_ids` number[]: DEPRECATED
  - `details` PlaybookPassFailDetail[]
    - `selection` string: Description of how the label should appear in the contract. Will be one of the following: `required`, `acceptable` or `unacceptable`
    - `reason` string: Reason why the label passed or failed. Will be one of the following: `required_and_found`, `required_not_found`, `acceptable_and_found`, `acceptable_not_found`, `unacceptable_and_found`, `unacceptable_not_found`
    - `is_fail` number: Result if label passed or failed
    - `label_id` string: ID of the label

---

[API](https://skmtc.dev/termscout/apis/termscout-data.md) - [All operations](https://skmtc.dev/termscout/apis/termscout-data/llms.txt) - [OpenAPI document](https://skmtc.dev/termscout/apis/termscout-data/revisions/ccf2baad9b8b?raw)