---
title: "List renewals"
method: GET
path: "/v3/renewals"
tags: ["Renewals"]
---

# List renewals

`GET /v3/renewals`

## Query parameters

- `page` number, required
- `limit` number, required
- `filter` string

## Response `200`

Get all Renewals by filter

- object
  - `payload` object, required — Response payload, will be empty when success is false
    - `data` RenewalDto[]
      - `id` string, required — Renewal Id
      - `contractId` string, required — Contract Id
      - `type` 'MUTUAL' | 'AUTOMATIC' | 'UNILATERAL' — Renewal Type
      - `status` 'DRAFT' | 'APPROVED' | 'DECLINED', required — Renewal Status
      - `noticePeriod` number — Notice Period
      - `noticePeriodUnits` 'DAY' | 'MONTH' | 'YEAR' — Notice Period Units
      - `renewalLength` number — Renewal Length
      - `renewalLengthUnits` 'DAY' | 'MONTH' | 'YEAR' — Renewal Length Units
      - `maxNumberOfRenewals` number — Max Number of Renewals
      - `sameConditions` boolean — Same Conditions
      - `priceIncrease` number — Price Increase
      - `priceIncreaseUnits` 'PERCENT' | 'DOLLAR' — Price Increase Units
      - `recurringPeriod` number — Recurring Period
      - `recurringPeriodUnits` 'DAY' | 'MONTH' | 'YEAR' — Recurring Period Units
      - `escalatorConditions` string — Escalator Conditions
      - `renewalCriteria` string — Renewal Criteria
      - `renewalCriteriaDetails` string — Renewal Criteria Details
      - `termEndDate` string — Term End Date
      - `escalatorClauseSummary` string — Escalator Clause Summary
      - `summary` string — Summary
      - `quotes` string — Quotes
    - `limit` number
    - `totalItems` number
    - `currentPage` number
  - `success` boolean, required — Boolean with true=success, false=failure
  - `message` string, required — Plain-text description of the result
  - `error` IntegratorsApiError, required
    - `code` number, required — API response code
    - `message` string, required — API response message
    - `details` object — Additional details about the error

---

[API](https://skmtc.net/tabsplatform/apis/tabs-external-api.md) · [All operations](https://skmtc.net/tabsplatform/apis/tabs-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tabsplatform/tabs-external-api/revisions/7e8885517814/schema)