Skip to content

Contracts

The contract register: every agreement, its dates, value, parties and linked records.

Loading a list with search, filters and paging? Use Contracts — list screen: the filters go in the request body.

Base path
/contracts

Endpoints

32 endpoints

Method

Standard Operations

7
  • GET /contracts List contracts (with search, filters and paging).
  • POST /contracts Create a new contract.
  • PATCH /contracts/bulk Update several contracts at once.
  • GET /contracts/{id} Open a single contract.
  • PUT /contracts/{id} Replace a contract's details in full.
  • PATCH /contracts/{id} Edit a contract.
  • DELETE /contracts/{id} Delete a contract.

Additional Operations

25
  • POST /contracts/obligations/csv Bulk-create flows for contracts from an uploaded spreadsheet.
  • GET /contracts/{contractId}/contacts List the people (contacts) linked to a contract.
  • GET /contracts/{contractId}/activity Show the activity history of a contract.
  • GET /contracts/{contractId}/reviews/itemreviews/files List documents attached to actions from this contract's reviews.
  • POST /contracts/{contractId}/files Attach a document to a contract.
  • DELETE /contracts/files/{fileId} Remove a document from a contract.
  • GET /contracts/search-kit Get the options that power the contract search panel.
  • GET /contracts/reports/action-log Action log report: all actions across contracts.
  • GET /contracts/reports/action-log/{id} Action log report for one contract.
  • GET /contracts/reports/treemap Treemap report: contract value broken down visually by category.
  • GET /contracts/reports/files-log Files log report: every document uploaded across contracts.
  • GET /contracts/reports/risk-log Risk log report: all risks across contracts.
  • GET /contracts/reports/risk-log/{id} Risk log report for one contract.
  • GET /contracts/reports/risk-log/progress/{id} Show how a contract's risks have progressed over time.
  • POST /contracts/csv Download the contracts list as a spreadsheet.
  • POST /contracts/reports/files-log/csv Download the files log report as a spreadsheet.
  • DELETE /contracts/{contractId}/tags/{tagId} Remove a tag from a contract.
  • GET /contracts/{id}/tags See the tags on a contract.
  • POST /contracts/{id}/tags Add a tag to a contract.
  • GET /contracts/timeline/contract-dates Key contract dates (start, end, renewal) for the timeline view.
  • GET /contracts/{id}/compliancerulealert Show compliance alerts raised on a contract.
  • GET /contracts/{id}/contract-analysis Show the AI analysis of a contract (clauses found, values extracted).
  • GET /contracts/{id}/contract-analysis-menu List the sections available in a contract's AI analysis.