API reference
Agreements
Read agreements, manage lifecycle events and review deviations.
List
GET/api/agreements
Returns the tenant’s agreements. Standard $select, $filter, $expand and $orderby query parameters are supported. Template agreements are filtered out by default.
Counterparty rollups
GET/api/counterparties
GET/api/counterparties/{name}/view
The counterparty view aggregates agreements, obligations, deviations and lifecycle events into one payload, used by the workspace Counterparty page.
Lifecycle events
POST/api/agreements/{agreement_id}/events
Add a lifecycle event (for example notice sent, renegotiation started, terminated).
Deviations
GET/api/deviations
POST/api/deviations/approve
POST/api/agreements/{agreement_id}/deviations/rerun
Dashboard summary
GET/api/dashboard/summary
Tile counts and time-series the workspace dashboard binds against.