v1

latestOpenAPI 3.0.12026-07-135210550.0 KB

Analyze Agreements

List Agreement Terms Data

Retrieve all term data associated with a specific agreement in Analyze.

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

Path parameters

idstring required

agreement id

Query parameters

namestring

Specify agreement type name to filter results [Case Sensitive]

sort_bystring

Specify the field to sort by [name]. Prepend - for descending [-name]

cursorstring

Specify cursor from previous response to get next page of data

page_sizestring

Specify page size of results, between 1 and 100

Response

successful without params

page_sizeinteger required

The number of results displayed

countinteger required

Total number of results found

next_cursorstring uuid nullable required

The string that must be passed to the cursor parameter to get the next page of results

Example response

{
  "page_size": 100,
  "count": 100,
  "terms": [
    {
      "id": "5d8f60b3-72b0-4495-9a65-e16c45784740",
      "name": "Effective Date",
      "value": "2022-12-25",
      "kind": "Date",
      "status": "User-Defined"
    }
  ]
}