API reference

Obligations

List

GET/api/obligations

Returns the tenant’s obligations. Template-agreement obligations are filtered out by default. Use $expand=citation to inline the citation row.

Edit

PATCH/api/obligations/{obligation_id}
json
{
  "value_text": "Net 45 from receipt of invoice",
  "value_numeric": 45,
  "value_unit": "days",
  "reason": "Negotiated extension agreed by AP on 2026-04-12"
}

Edit history

GET/api/obligations/{obligation_id}/edits

Returns the immutable edit trail: every verify, override and patch with the responsible user, timestamp and reason.

Citation document

GET/api/document?id={document_id}

Streams the source PDF bytes. Used by the in-app viewer for highlighted citations.

Review queue

GET/api/review-queue

The set of AI-proposed obligations awaiting human review.