---
title: "GET /policy/{tenantLocator}/terms/{locator}/summary"
method: GET
path: "/policy/{tenantLocator}/terms/{locator}/summary"
---

# GET /policy/{tenantLocator}/terms/{locator}/summary

`GET /policy/{tenantLocator}/terms/{locator}/summary`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/policy/{tenantLocator}/terms/{locator}/summary`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/policy/:tenantLocator/terms/:locator/summary/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantLocator` string, uuid, required
- `locator` string, ulid, required

## Response `200`

OK

- TermSummary
  - `policyLocator` string, ulid, required
  - `locator` string, ulid, required
  - `staticLocator` string, ulid, required
  - `termNumber` integer, required
  - `startTime` string, date-time, required
  - `endTime` string, date-time, required
  - `duration` number, required
  - `durationBasis` 'years' | 'months' | 'weeks' | 'days' | 'hours', required
  - `subsegments` SubsegmentSummary[], required
    - `locator` string, ulid, required
    - `type` 'coverage' | 'gap', required
    - `basedOn` string, ulid, required
    - `startTime` string, date-time, required
    - `endTime` string, date-time, required
    - `duration` number, required
    - `producerInfo` ProducerInfo
      - `producerCode` string
      - `producerCodeOfRecord` string
    - `elements` ElementSummary[], required
      - `locator` string, ulid, required
      - `staticLocator` string, ulid, required
      - `type` string, required
      - `data` object, required
      - `chargeSummaries` object, required
    - `documentSummary` DocumentSummary[], required
      - `locator` string, ulid, required
      - `name` string
      - `staticName` string
      - `documentInstanceState` 'draft' | 'dataReady' | 'ready' | 'dataError' | 'renderError' | 'conversionError' | 'rendered' | 'removed', required
      - `referenceType` 'quote' | 'policy' | 'invoice' | 'transaction' | 'segment' | 'term' | 'quoteGroup', required
      - `state` 'draft' | 'dataReady' | 'ready' | 'dataError' | 'renderError' | 'conversionError' | 'rendered' | 'removed', required

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/6537d24b3693?raw)