List Contract Series

Retrieve contract numbering series configured for the workspace.

Method

GET /v1/contract-series

Query Parameters

activeOnly · boolean

Filter to active series only (defaults to false).

limit · integer

Max items to return (1–100).

offset · integer

Number of records to skip for pagination (defaults to 0).

Headers

Authorization · string

Bearer token (requires contract-series:read).

Request Example

cURL

curl "https://api.voyantcloud.com/v1/contract-series?activeOnly=true&limit=20" \
  -H "Authorization: Bearer $VOYANT_API_KEY"

Response

200 OK

{
  "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
}

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