---
title: "General overview and metadata for a given contract"
method: GET
path: "/contracts/{contract-id}/overview"
---

# General overview and metadata for a given contract

`GET /contracts/{contract-id}/overview`

## Request

- Base URL: `https://api.termscout.com`
- URL: `https://api.termscout.com/contracts/{contract-id}/overview`
- 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/overview/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `contract-id` string, required

## Response `200`

200 response

- ContractOverview: Contract overview and general metadata
  - `party_a` string: One of the parties in the contract
  - `party_b` string: The other party in the contract
  - `template_id` number: ID of the template this contract belongs to
  - `template_name` string: Name of the template this contract belongs to, e.g., 'IT' or 'Business Intelligence Software'
  - `parent_template_id` number: ID of the parent template
  - `is_public` number: Visibility of contract. `1` if public, `0` if private
  - `contract_position_id` number: Contract position id of contract
  - `rating_display` string: User friendly display of contract rating
  - `product_suite_id` number: ID of product suite, or company, that contract belongs to
  - `product_suite_name` string: Name of product suite, or company, that contract belongs to
  - `product_suite_url` string: DEPRECATED
  - `max_score` number, double: Max score
  - `overall_score` number, double: Numeric representation of the overall score
  - `rating_percentile` number, double: Number value of contract rating. On a scale of 0-10, 0 is Vendor Favorable, 5 is Balanced and 10 is Customer Favorable
  - `rating` string: Display friendly rating of contract. Will be one of `Customer Favorable`, `Vendor Favorable` or `Balanced`
  - `raw_rating` string: Raw rating number of contract
  - `primary_agreement` string: Primary agreement name for the contract
  - `primary_agreement_url` string, uri: Source URL for the contract, where it originated from online
  - `last_updated` string, datetime: Date and time contract was last reviewed
  - `overall_clarity` string: Clarity of given contract
  - `contract_position` string: Position of contract
  - `logo_url` string, uri: Location of image for contract or product suite
  - `badge_url` string, uri: Location of badge
  - `legal_entity` string: Name of legal entity the contract belongs to
  - `secondary_categories` string[]: Secondary categories of contract
  - `primary_agreement_defined_term` string: Primary agreement defined term, or short name of primary agreement
  - `notes_to_customer` string: Notes to customer
  - `primary_category_id` number: Category id of contract
  - `category` string: Display friendly category name
  - `category_url` string: DEPRECATED

---

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