v1

latestOpenAPI 3.0.12026-07-135210550.0 KB

Analyze Agreements

List Agreements

Retrieve a list of agreements in Analyze, with options to filter and paginate.

get/analyze/v1/agreements

Query parameters

typestring

Specify agreement type name to filter results by agreement type [Case Sensitive]

tagsstring

Specify comma separated tags to return agreements with all tags requested [Case Sensitive]

after_datestring

Specify after_date which will return all agreements updated since date [YYYY-MM-DD]

sort_bystring

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

cursorstring

Specify cursor from previous response to get next page of data

tags_delimiterstring

Specify a delimiter to separate tags, default is comma [,]. Acceptable delimiters [- ~ . _ ,]

page_sizestring

Specify page size of results, between 1 and 100

Response

success

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,
  "agreements": [
    {
      "id": "269b36b3-df8d-4481-81f8-72c97a7c1e1a",
      "parent_agreement_id": "77213953-7d73-497c-8786-6bd136b197d4",
      "finalize_agreement_id": "bfac6469-164f-4965-9e8c-933ef85833f5",
      "name": "Example Agreement Name",
      "original_name": "Example Original File Name",
      "updated_date": "2023-06-27T14:27:11.022-04:00",
      "upload_date": "2023-06-27T14:27:11.022-04:00",
      "uploaded_by": "John Doe",
      "type": {
        "id": "a223bf8c-a25b-4811-8b12-f0246d33df99",
        "name": "Master Agreement"
      },
      "tags": [
        {
          "id": "6df3cb35-2481-45c8-84b0-06db1a025c54",
          "name": "Blue"
        }
      ],
      "child_agreements": [
        {
          "id": "6d37ecf4-6857-439f-adf5-ac015632baab"
        }
      ],
      "terms": [
        {
          "id": "11e68e8b-4723-4a08-98d8-02f788224b95",
          "name": "Effective Date",
          "value": "2022-12-25",
          "kind": "Date",
          "status": "User-Defined"
        }
      ]
    }
  ]
}