List contracts

GET

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

GET

/v3/contracts

$ curl -G https://integrators.prod.api.tabsplatform.com/v3/contracts \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d page=1 \
>      -d limit=50

200Retrieved

1 {
2   "payload": {
3     "data": [
4       {
5         "id": "9f8b7c6d-1234-4a56-b789-0a1b2c3d4e5f",
6         "fileName": "Service_Agreement_2024.pdf",
7         "name": "Service Agreement 2024",
8         "status": "ACTIVE",
9         "customerId": "4a3b2c1d-5678-4e90-b123-456789abcdef",
10         "customerName": "Acme Corporation",
11         "createdAt": "2024-04-10T09:15:00.000Z",
12         "closeDate": "2025-04-09",
13         "lastUpdatedAt": "2024-05-01T14:30:00.000Z",
14         "deletedAt": null,
15         "externalIds": [
16           {
17             "externalId": "ns-7890-1234-5678",
18             "sourceType": "NETSUITE",
19             "metadata": {
20               "orderId": "ORD-20240410-001"
21             }
22           }
23         ],
24         "source": "CRM",
25         "jobId": "wf-9f8b7c6d-1234-4a56-b789-0a1b2c3d4e5f",
26         "documentClassifications": [
27           "ORDER_FORM",
28           "MSA"
29         ]
30       }
31     ],
32     "limit": 50,
33     "totalItems": 1,
34     "currentPage": 1
35   },
36   "success": true,
37   "message": "Contracts retrieved successfully",
38   "error": {
39     "code": 0,
40     "message": "",
41     "details": {}
42   }
43 }

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: name (string): eq, neq, like, nlike, in, nin, isnull, isnotnull externalIds.externalId (string): eq, neq, like, nlike, in, nin, isnull, isnotnull externalIds.sourceType (string): eq, neq, like, nlike, in, nin, isnull, isnotnull source (string): eq, neq, like, nlike, in, nin, isnull, isnotnull status (string): eq, neq, like, nlike, in, nin, isnull, isnotnull customerId (uuid): eq, neq, in, nin, isnull, isnotnull createdAt (datetime): eq, neq, gt, gte, lt, lte lastUpdatedAt (datetime): eq, neq, gt, gte, lt, lte

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

Example: filter=name:eq:value

Format: field:rule:value — comma-separated for multiple filters. Fields: name (string): eq, neq, like, nlike, in, nin, isnull, isnotnull externalIds.externalId (string): eq, neq, like, nlike, in, nin, isnull, isnotnull externalIds.sourceType (string): eq, neq, like, nlike, in, nin, isnull, isnotnull source (string): eq, neq, like, nlike, in, nin, isnull, isnotnull status (string): eq, neq, like, nlike, in, nin, isnull, isnotnull customerId (uuid): eq, neq, in, nin, isnull, isnotnull createdAt (datetime): eq, neq, gt, gte, lt, lte lastUpdatedAt (datetime): eq, neq, gt, gte, lt, lte Date-only values (YYYY-MM-DD) match the full UTC day. Example: filter=name:eq:value

Response

Get all Contracts 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