Get contract by ID

GET

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

GET

/v3/contracts/:id

$ curl https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000 \
>      -H "Authorization: <apiKey>"

1 {
2   "payload": {
3     "id": "123e4567-e89b-12d3-a456-426614174000",
4     "fileName": "Contract.pdf",
5     "name": "Contract",
6     "status": "ACTIVE",
7     "customerId": "123e4567-e89b-12d3-a456-426614174000",
8     "customerName": "John Doe",
9     "createdAt": "2024-01-01T00:00:00.000Z",
10     "closeDate": "2024-01-01",
11     "lastUpdatedAt": "2024-01-01T00:00:00.000Z",
12     "deletedAt": "2024-01-01T00:00:00.000Z",
13     "externalIds": [
14       {
15         "externalId": "123e4567-e89b-12d3-a456-426614174000",
16         "sourceType": "NETSUITE"
17       }
18     ],
19     "source": "CRM",
20     "jobId": "wf-123e4567-e89b-12d3-a456-426614174000",
21     "documentClassifications": [
22       "ORDER_FORM",
23       "MSA"
24     ]
25   },
26   "success": true,
27   "message": "string",
28   "error": {
29     "code": 1.1,
30     "message": "string",
31     "details": {}
32   }
33 }

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Contract Id

Response

The contract

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

Errors

400

Bad Request Error

404

Not Found Error