Skip to main content

​
Method

GET /v1/contract-series/:id

​
Path Parameters

​
id
uuid
required
Contract series ID.

​
Headers

​
Authorization
string
Bearer token (requires contract-series:read).

​
Request Example

curl "https://api.voyantcloud.com/v1/contract-series/cs_01HZYQ0RN0AT4Z2ZEYQXT4S1B2" \
  -H "Authorization: Bearer $VOYANT_API_KEY"

​
Response

{
  "series": {
    "id": "cs_01HZYQ0RN0AT4Z2ZEYQXT4S1B2",
    "workspaceId": "ws_01HZYPM2QF2R8X9SZQ0J9SYBCN",
    "name": "Core Contracts",
    "prefix": "CNT",
    "pattern": "CNT-{year}-{sequence}",
    "resetPeriod": "year",
    "startValue": 100,
    "enforceGapless": true,
    "enforceMonotonicDates": true,
    "active": true,
    "defaultForBe": true,
    "createdAt": "2025-01-06T10:14:32.000Z",
    "updatedAt": "2025-03-20T08:02:11.000Z"
  }
}
Requests for a non-existent ID return 404 with { "error": "Contract series not found", "code": "NOT_FOUND_404" }.