> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.tabs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.tabs.com/_mcp/server.

# List renewals

GET https://integrators.prod.api.tabsplatform.com/v3/renewals

Reference: https://docs.tabs.com/api-reference/renewals/getRenewals

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: Tabs External API
  version: 1.0.0
paths:
  /v3/renewals:
    get:
      operationId: integrators-api-renewals-controller-get-renewals
      summary: List renewals
      tags:
        - renewals
      parameters:
        - name: page
          in: query
          description: Page Number
          required: true
          schema:
            type: number
            format: double
            default: 1
        - name: limit
          in: query
          description: Number of items to return
          required: true
          schema:
            type: number
            format: double
            default: 50
        - name: filter
          in: query
          description: |-
            Format: field:rule:value — comma-separated for multiple filters.

            Fields:
              contractId (uuid): eq, neq, in, nin, isnull, isnotnull
              type (string): eq, neq, like, nlike, in, nin, isnull, isnotnull
              status (string): eq, neq, like, nlike, in, nin, isnull, isnotnull
              contractEndDate (datetime): eq, neq, gt, gte, lt, lte

            Date-only values (YYYY-MM-DD) match the full UTC day.

            Example: filter=contractId:eq:00000000-0000-0000-0000-000000000001
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Get all Renewals by filter
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Renewals_IntegratorsApiRenewalsController_getRenewals_Response_200
servers:
  - url: https://integrators.prod.api.tabsplatform.com
    description: https://integrators.prod.api.tabsplatform.com
components:
  schemas:
    V3RenewalsGetResponsesContentApplicationJsonSchemaPayload:
      type: object
      properties: {}
      description: Response payload, will be empty when success is false
      title: V3RenewalsGetResponsesContentApplicationJsonSchemaPayload
    IntegratorsApiErrorDetails:
      type: object
      properties: {}
      description: Additional details about the error
      title: IntegratorsApiErrorDetails
    IntegratorsApiError:
      type: object
      properties:
        code:
          type: number
          format: double
          description: API response code
        message:
          type: string
          description: API response message
        details:
          $ref: '#/components/schemas/IntegratorsApiErrorDetails'
          description: Additional details about the error
      required:
        - code
        - message
      title: IntegratorsApiError
    Renewals_IntegratorsApiRenewalsController_getRenewals_Response_200:
      type: object
      properties:
        payload:
          $ref: >-
            #/components/schemas/V3RenewalsGetResponsesContentApplicationJsonSchemaPayload
          description: Response payload, will be empty when success is false
        success:
          type: boolean
          description: Boolean with true=success, false=failure
        message:
          type: string
          description: Plain-text description of the result
        error:
          $ref: '#/components/schemas/IntegratorsApiError'
          description: json element with any error messages or warnings
      required:
        - payload
        - success
        - message
        - error
      title: Renewals_IntegratorsApiRenewalsController_getRenewals_Response_200
  securitySchemes:
    custom-header:
      type: apiKey
      in: header
      name: Authorization

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "payload": {
    "data": [
      {
        "id": "a3f1c9d2-4b7e-4f8a-9c3d-2e5f7b8a9c01",
        "contractId": "b7d9e8f3-2c4a-4d6b-8f9e-1a2b3c4d5e6f",
        "type": "AUTOMATIC",
        "status": "DRAFT",
        "noticePeriod": 30,
        "noticePeriodUnits": "DAY",
        "renewalLength": 12,
        "renewalLengthUnits": "MONTH",
        "maxNumberOfRenewals": 3,
        "sameConditions": true,
        "priceIncrease": 5.5,
        "priceIncreaseUnits": "PERCENT",
        "recurringPeriod": 12,
        "recurringPeriodUnits": "MONTH",
        "escalatorConditions": "Based on CPI",
        "renewalCriteria": "Performance metrics",
        "renewalCriteriaDetails": "Must meet 95% SLA",
        "termEndDate": "2024-12-31",
        "escalatorClauseSummary": "Annual increase",
        "summary": "Automatic renewal with 30 day notice",
        "quotes": "Renewal quote details pending"
      }
    ],
    "limit": 1,
    "totalItems": 1,
    "currentPage": 1
  },
  "success": true,
  "message": "Renewals retrieved successfully",
  "error": {
    "code": 0,
    "message": "",
    "details": {}
  }
}
```

**SDK Code**

```python
import requests

url = "https://integrators.prod.api.tabsplatform.com/v3/renewals"

querystring = {"page":"1","limit":"50","filter":"status:eq:APPROVED"}

payload = {}
headers = {
    "Authorization": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://integrators.prod.api.tabsplatform.com/v3/renewals?page=1&limit=50&filter=status%3Aeq%3AAPPROVED';
const options = {
  method: 'GET',
  headers: {Authorization: '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://integrators.prod.api.tabsplatform.com/v3/renewals?page=1&limit=50&filter=status%3Aeq%3AAPPROVED"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://integrators.prod.api.tabsplatform.com/v3/renewals?page=1&limit=50&filter=status%3Aeq%3AAPPROVED")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://integrators.prod.api.tabsplatform.com/v3/renewals?page=1&limit=50&filter=status%3Aeq%3AAPPROVED")
  .header("Authorization", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://integrators.prod.api.tabsplatform.com/v3/renewals?page=1&limit=50&filter=status%3Aeq%3AAPPROVED', [
  'body' => '{}',
  'headers' => [
    'Authorization' => '<apiKey>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://integrators.prod.api.tabsplatform.com/v3/renewals?page=1&limit=50&filter=status%3Aeq%3AAPPROVED");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://integrators.prod.api.tabsplatform.com/v3/renewals?page=1&limit=50&filter=status%3Aeq%3AAPPROVED")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```