Skip to content

Templates

Template discovery and published-template metadata.

v1 · 2026-01-15

GET/templatesRequires authentication

List templates (read-only)

Parameters

NameInTypeRequired
statusquerystringNo
searchquerystringNo
limitqueryintegerNo
offsetqueryintegerNo
sortByquerystringNo
sortOrderquerystringNo

Responses

  • 200Template list
  • defaultStandardized API error
GET/templates/{id}Requires authentication

Get template details and versions

Parameters

NameInTypeRequired
idpathstringYes

Responses

  • 200Template details
  • defaultStandardized API error
GET/templates/{id}/published-versionRequires authentication

Get latest published template version

Returns the latest published template version metadata plus an integrator-facing `inputSchema`. The `inputSchema` is a normalized business data model for API integrations (form generation / validation), not internal editor layout or document-node structure. `inputSchema.schemaVersion` identifies schema shape version. `inputSchema.submissionMode` is currently `data` and indicates recommended request style. `inputSchema.tableSubmissionMode` is currently `array_of_rows` and defines table payload shape. Field `key` is the canonical submission key for `POST /contracts` `data`. Field `name` is informational/display-oriented. For `type=table` fields, `columns[]` defines row-entry structure. Use this in one call to fetch template metadata, published-version metadata, roles, organization signing mode, and structured contract input requirements. `inputSchema` shape is stable across template versions (`sections[]` / `fields[]` contract). Concrete fields are version-scoped; re-fetch when template version changes. `publishedVersion.organizationSigningMode` is normalized to `automatic` when missing or invalid in template content.

Parameters

NameInTypeRequired
idpathstringYes
includeContentquerybooleanNo

Responses

  • 200Published version
  • defaultStandardized API error