> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voyantcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Contract Series

> Retrieve contract numbering series configured for the workspace.

## Method

`GET` `/v1/contract-series`

## Query Parameters

<ParamField query="activeOnly" type="boolean">Filter to active series only (defaults to `false`).</ParamField>
<ParamField query="limit" type="integer">Max items to return (1–100).</ParamField>
<ParamField query="offset" type="integer">Number of records to skip for pagination (defaults to `0`).</ParamField>

## Headers

<ParamField header="Authorization" type="string">Bearer token (requires `contract-series:read`).</ParamField>

## Request Example

<RequestExample>
  ```bash cURL theme={null}
  curl "https://api.voyantcloud.com/v1/contract-series?activeOnly=true&limit=20" \
    -H "Authorization: Bearer $VOYANT_API_KEY"
  ```

  ```javascript Node.js theme={null}
  const res = await fetch("https://api.voyantcloud.com/v1/contract-series?offset=10", {
    headers: { Authorization: `Bearer ${process.env.VOYANT_API_KEY}` },
  })
  const { items, total } = await res.json()
  ```

  ```python Python theme={null}
  import os, requests

  resp = requests.get(
    "https://api.voyantcloud.com/v1/contract-series",
    params={"activeOnly": True},
    headers={"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}"},
  )
  series = resp.json()
  ```
</RequestExample>

## Response

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "items": [
      {
        "id": "cs_01HZYQ0RN0AT4Z2ZEYQXT4S1B2",
        "workspaceId": "ws_01HZYPM2QF2R8X9SZQ0J9SYBCN",
        "name": "Core Contracts",
        "prefix": "CNT",
        "pattern": "CNT-{year}-{sequence}",
        "resetPeriod": "year",
        "startValue": 1,
        "enforceGapless": true,
        "enforceMonotonicDates": true,
        "active": true,
        "defaultForBe": true,
        "createdAt": "2025-01-06T10:14:32.000Z",
        "updatedAt": "2025-03-20T08:02:11.000Z"
      }
    ],
    "total": 1
  }
  ```
</ResponseExample>

<Tip>
  All booleans in query parameters accept either `true`/`false` or `1`/`0` thanks to schema coercion.
</Tip>