---
title: "List Clause Categories"
method: GET
path: "/analyze/v1/clause_categories"
tags: ["Analyze Clauses"]
---

# List Clause Categories

`GET /analyze/v1/clause_categories`

## Request

- Base URL: `https://api.linksquares.com/api`
- URL: `https://api.linksquares.com/api/analyze/v1/clause_categories`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/linksquares/apis/linksquares-api/docs/analyze/v1/clause_categories/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Query parameters

- `name` string
- `sort_by` string
- `cursor` string
- `page_size` string

## Response `200`

successful without params

- object
  - `page_size` integer, required: The number of results displayed
  - `count` integer, required: Total number of results found
  - `next_cursor` string, uuid, nullable, required: The string that must be passed to the cursor parameter to get the next page of results
  - `clause_categories` object[], nullable, required
    - `id` string, required: UUID of the Clause Category
    - `name` string, required: Clause Category Name
    - `created_at` string, required: Created Date of Clause Category
    - `updated_at` string, required: Last Updated Date of Clause Category

## Other responses

- `403`: inactive user
- `422`: cursor is invalid

---

[API](https://skmtc.dev/linksquares/apis/linksquares-api.md) - [All operations](https://skmtc.dev/linksquares/apis/linksquares-api/llms.txt) - [OpenAPI document](https://skmtc.dev/linksquares/apis/linksquares-api/revisions/4d597e83cd78?raw)