---
title: "Predicted red flags"
method: GET
path: "/contracts/{contract-id}/prediction-flags"
---

# Predicted red flags

`GET /contracts/{contract-id}/prediction-flags`

## Request

- Base URL: `https://api.termscout.com`
- URL: `https://api.termscout.com/contracts/{contract-id}/prediction-flags`
- 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/prediction-flags/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

## Response `200`

200 response

- PredictionFlags: Predicted red flags for the given contract
  - `contract_id` string: ID of the contract
  - `details` PredictionFlagsDetail[]
    - `name` string: Perspective name, eg. Customer, Vendor
    - `flag_count` number: Number of red flags identified for the given perspective
    - `flags` PredictionFlag[]
      - `label_id` number: ID of the label
      - `label_display` string: Display name of the label
      - `confidence` number: Prediction confidence
      - `defined_term` string: Defined term of the document where the prediction was found
      - `citation` string: Section identifier where the prediction was found
      - `source_language` string: Source language where the prediction was found
      - `selected` number: Whether or not the label was selected in the affirmative or not: 1 for selected and 0 for unselected

---

[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)