v1

latestOpenAPI 3.0.12026-07-135210550.0 KB

Analyze Clauses

List Clause Categories

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

get/analyze/v1/clause_categories

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,
  "clause_categories": [
    {
      "id": "dacb0d83-f240-496b-9a86-118f5935165e",
      "name": "Example Agreement Name",
      "created_at": "2023-06-27T14:27:11.022-04:00",
      "updated_at": "2023-06-27T14:27:11.022-04:00"
    }
  ]
}