Contracts API
31 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.
| Method | Path | Description |
|---|---|---|
GET |
/api/contracts/ |
List Contracts Query: status, account_id, opportunity_id, expiring_within. |
POST |
/api/contracts/ |
Create Contract Accepts a JSON body. |
GET |
/api/contracts/dashboard |
Get Dashboard |
GET |
/api/contracts/expiring |
Get Expiring Contracts Query: days. |
POST |
/api/contracts/from-order/{order_id} |
Create Contract From Order |
GET |
/api/contracts/templates |
List Templates Query: category. |
POST |
/api/contracts/templates |
Create Template Accepts a JSON body. |
GET |
/api/contracts/templates/{template_id} |
Get Template |
PATCH |
/api/contracts/templates/{template_id} |
Update Template Accepts a JSON body. |
DELETE |
/api/contracts/templates/{template_id} |
Delete Template |
POST |
/api/contracts/templates/{template_id}/render |
Render Template Accepts a JSON body. |
GET |
/api/contracts/{contract_id} |
Get Contract |
PATCH |
/api/contracts/{contract_id} |
Update Contract Accepts a JSON body. |
DELETE |
/api/contracts/{contract_id} |
Delete Contract |
POST |
/api/contracts/{contract_id}/activate |
Activate Contract |
POST |
/api/contracts/{contract_id}/amend |
Amend Contract Query: reason. |
POST |
/api/contracts/{contract_id}/approve |
Approve Contract |
POST |
/api/contracts/{contract_id}/create-renewal |
Create Renewal From Contract |
POST |
/api/contracts/{contract_id}/generate-pdf |
Generate Contract Pdf Route |
GET |
/api/contracts/{contract_id}/obligations |
List Obligations |
POST |
/api/contracts/{contract_id}/obligations |
Create Obligation Accepts a JSON body. |
PATCH |
/api/contracts/{contract_id}/obligations/{obligation_id} |
Update Obligation Accepts a JSON body. |
DELETE |
/api/contracts/{contract_id}/obligations/{obligation_id} |
Delete Obligation |
POST |
/api/contracts/{contract_id}/obligations/{obligation_id}/complete |
Complete Obligation |
GET |
/api/contracts/{contract_id}/pdf |
Download Contract Pdf |
POST |
/api/contracts/{contract_id}/send-for-signature |
Send For Signature |
GET |
/api/contracts/{contract_id}/signers |
Get Signers |
PUT |
/api/contracts/{contract_id}/signers |
Set Signers Accepts a JSON body. |
POST |
/api/contracts/{contract_id}/submit-review |
Submit For Review |
POST |
/api/contracts/{contract_id}/terminate |
Terminate Contract Query: reason. |
GET |
/api/contracts/{contract_id}/versions |
Get Versions |
Try it
The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.