v1

latestOpenAPI 3.0.12026-07-135210550.0 KB

Analyze Clauses

List Clauses

Retrieve a list of clauses in Analyze, with options to filter by clause category and paginate.

get/analyze/v1/clauses

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

clause_category_idstring

Specify the clause category id to filter results

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,
  "clause_categories": [
    {
      "id": "e350ab48-f65b-4504-9bfc-64502cc9ad93",
      "name": "Example Clause Name",
      "text": "lorem ipsum",
      "clause_category_id": "1650aba4-91f7-4855-90b4-d1f00564566b",
      "note": "Please adhere to this note.",
      "agreement_id": "05849aab-988d-439e-85f0-e1eceb7a4b7b",
      "created_at": "2023-06-27T14:27:11.022-04:00",
      "updated_at": "2023-06-27T14:27:11.022-04:00",
      "author_name": "John Doe"
    }
  ]
}