List Clauses

Your Company APIClauses

GEThttps://api.your-company.example/v1/clauses

AuthenticationRequires bearerAuth.

Description

Searches active and retired Clause Library entries in the Workspace.

Request

curl "https://api.your-company.example/v1/clauses?limit=20&cursor=string&query=limitation%20of%20liability&category=Risk%20allocation&status=draft" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.your-company.example/v1/clauses?limit=20&cursor=string&query=limitation%20of%20liability&category=Risk%20allocation&status=draft", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
  },
});

import requests

response = requests.get(
    "https://api.your-company.example/v1/clauses",
    params={
      "limit": "20",
      "cursor": "string",
      "query": "limitation of liability",
      "category": "Risk allocation",
      "status": "draft"
    },
    headers={
      "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response200JSON

{
  "data": [
    {
      "id": "cls_01J8V1B4H6",
      "title": "Mutual liability cap",
      "category": "Risk allocation",
      "text": "Except for excluded claims, each party's aggregate liability will not exceed fees paid or payable in the twelve months before the event giving rise to the claim.",
      "status": "approved",
      "version": 4,
      "tags": [
        "liability",
        "mutual",
        "fees"
      ],
      "owner_id": "usr_01J7Z9K3W8",
      "reviewed_at": "2026-04-17T15:00:00Z",
      "updated_at": "2026-04-17T15:00:00Z"
    }
  ],
  "next_cursor": null
}

Parameters

limitqueryintegerdefault: 20

Maximum number of records to return, from 1 to 100.

cursorquerystring

Opaque cursor from the previous page response.

queryquerystring

Text matched against Clause titles, text, and tags.

categoryquerystring

Return only Clauses in this category.

statusquerystring

Allowed values: draftapprovedretired

Return Clauses with this governance status.

Responses

200A page of Clauses.application/json

dataobject[]required

Array item fields

idstringrequired

titlestringrequired

categorystringrequired

textstringrequired

Preferred contract language.

drafting_notestring | null

Internal guidance for editors.

fallback_positionsobject[]

Array item fields

labelstringrequired

textstringrequired

Approved alternative language.

requires_approvalbooleanrequired

Whether using this fallback triggers an Approval Chain.

statusstringrequired

Allowed values: draftapprovedretired

Governance status of a Clause version.

versionintegerrequired

tagsstring[]required

owner_idstringrequired

reviewed_atstring | null

updated_atstring <date-time>required

next_cursorstring | nullrequired

Example response

{
  "data": [
    {
      "id": "cls_01J8V1B4H6",
      "title": "Mutual liability cap",
      "category": "Risk allocation",
      "text": "Except for excluded claims, each party's aggregate liability will not exceed fees paid or payable in the twelve months before the event giving rise to the claim.",
      "status": "approved",
      "version": 4,
      "tags": [
        "liability",
        "mutual",
        "fees"
      ],
      "owner_id": "usr_01J7Z9K3W8",
      "reviewed_at": "2026-04-17T15:00:00Z",
      "updated_at": "2026-04-17T15:00:00Z"
    }
  ],
  "next_cursor": null
}

401The API key is missing, malformed, expired, or revoked.application/json

errorobjectrequired

Object fields

codestringrequired

Stable machine-readable error code.

messagestringrequired

Human-readable summary.

request_idstringrequired

Identifier to include in a support ticket.

detailsobject[]

Array item fields

fieldstringrequired

Request field with an issue.

issuestringrequired

Human-readable validation problem.

Example response

{
  "error": {
    "code": "unauthorized",
    "message": "Provide a valid bearer API key.",
    "request_id": "req_01JAZA0P8M"
  }
}