Get Contract Template

Retrieve a contract template by ID, with optional locale-specific content.

Method

GET /v1/contract-templates/:id

Path Parameters

id · uuid · required

Contract template ID.

Query Parameters

locale · string

Return a localized variant (alias: lang).

Headers

Authorization · string

Bearer token (requires contract-templates:read).

Request Example

cURL

curl "https://api.voyantcloud.com/v1/contract-templates/ct_01J0BE7Z3S494F9D4T3E2QJ0XR?locale=fr" \
  -H "Authorization: Bearer $VOYANT_API_KEY"

Response

200 OK

{
  "template": {
    "id": "ct_01J0BE7Z3S494F9D4T3E2QJ0XR",
    "workspaceId": "ws_01HZYPM2QF2R8X9SZQ0J9SYBCN",
    "name": "Customer Master Agreement",
    "type": "customer",
    "description": "Standard customer contract",
    "templateJson": {
      "sections": [
        {
          "type": "paragraph",
          "text": "This Agreement is made between {{seller.name}} and {{buyer.name}}."
        }
      ]
    },
    "active": true,
    "createdBy": null,
    "createdAt": "2025-01-10T11:08:44.000Z",
    "updatedAt": "2025-03-05T16:32:18.000Z",
    "locale": "fr",
    "bodyHtml": "<p>Ce contrat lie {{seller.name}} à {{buyer.name}}.</p>",
    "variables": {
      "seller.name": "Raison sociale du vendeur",
      "buyer.name": "Raison sociale du client"
    }
  }
}

An invalid or missing template ID returns 404 with { "error": "Contract template not found", "code": "NOT_FOUND_404" }.