v1

latestOpenAPI 3.0.12026-07-135210550.0 KB

Analyze Agreements

Get Agreement Hierarchy

Retrieve a JSON-formatted hierarchy of an agreement, detailing parent and child agreements with IDs, names, effective dates, and upload dates.

get/analyze/v1/agreements/{id}/hierarchy

Path parameters

idstring required

agreement id

Response

successful

namestring required

Agreement Name (Parent)

effective_datestring nullable required

Effective Date of Agreement

agreement_idstring uuid required

UUID of the Agreement

upload_datestring required

Upload Date of the Agreement

Example response

{
  "name": "Example Master Agreement",
  "effective_date": "2021-09-23",
  "upload_date": "2022-10-23",
  "children": [
    {
      "name": "Example Child Agreement Name",
      "effective_date": "2020-04-23",
      "upload_date": "2022-03-23",
      "children": [
        {
          "name": "Example Child Agreement Name",
          "effective_date": "2021-01-23",
          "upload_date": "2022-12-23"
        }
      ]
    }
  ]
}