List renewals

GET

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

GET

/v3/renewals

$ curl -G https://integrators.prod.api.tabsplatform.com/v3/renewals \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d page=1 \
>      -d limit=50 \
>      --data-urlencode filter=status:eq:APPROVED

200Retrieved

1 {
2   "payload": {
3     "data": [
4       {
5         "id": "a3f1c9d2-4b7e-4f8a-9c3d-2e5f7b8a9c01",
6         "contractId": "b7d9e8f3-2c4a-4d6b-8f9e-1a2b3c4d5e6f",
7         "type": "AUTOMATIC",
8         "status": "DRAFT",
9         "noticePeriod": 30,
10         "noticePeriodUnits": "DAY",
11         "renewalLength": 12,
12         "renewalLengthUnits": "MONTH",
13         "maxNumberOfRenewals": 3,
14         "sameConditions": true,
15         "priceIncrease": 5.5,
16         "priceIncreaseUnits": "PERCENT",
17         "recurringPeriod": 12,
18         "recurringPeriodUnits": "MONTH",
19         "escalatorConditions": "Based on CPI",
20         "renewalCriteria": "Performance metrics",
21         "renewalCriteriaDetails": "Must meet 95% SLA",
22         "termEndDate": "2024-12-31",
23         "escalatorClauseSummary": "Annual increase",
24         "summary": "Automatic renewal with 30 day notice",
25         "quotes": "Renewal quote details pending"
26       }
27     ],
28     "limit": 1,
29     "totalItems": 1,
30     "currentPage": 1
31   },
32   "success": true,
33   "message": "Renewals retrieved successfully",
34   "error": {
35     "code": 0,
36     "message": "",
37     "details": {}
38   }
39 }

Authentication

Authorizationstring

API Key authentication via header

Query parameters

pagedoubleRequiredDefaults to 1

Page Number

limitdoubleRequiredDefaults to 50

Number of items to return

filterstringOptional

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

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

Response

Get all Renewals by filter

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobject

json element with any error messages or warnings