Skip to main content

Get the key numbers

GET /v1/overview returns the numbers from the Home page in the Watchdog app in one request: invoice spend, open alerts, claims and agreements, plus suggested next steps. Amounts are kept separate per currency. recent covers the last seven days.

Find a record

GET /v1/search finds agreements, invoices, alerts, topics and claims by name or number. The best matches come first. Use types to search only some kinds of records.
A search shorter than three characters only matches the start of a name or number.

Search agreement text

POST /v1/documents/search searches the text of your agreements and returns the most relevant passages. Documents that can’t be searched yet are listed in unavailable_documents; POST /v1/documents/{id}/index prepares one for search. Use mode: exact with explicit document_ids to find literal text without an agreement ID. A partial result from a large document does not prove that text is absent. Ranked search is the default.