Get Contract Template Preview

Get contract template preview

Returns the preview strategy for the template. PDFs are exposed as inline file
content, while DOCX templates reuse the embedded document builder session so the
dashboard can render them in-browser.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Return the preview strategy for one of your contract template versions. It resolves the template version you own, opens a short-lived embedded document-builder session for it, and returns the mode the dashboard should use to render the preview along with the session details. This is a read-only call: it does not modify the template.

Authentication & access

  • Requires a client API token: Authorization: Bearer <token>.
  • The caller must hold the contracts.templates.read permission and have the OWNER, OPERATIONS, or DEVELOPER role.
  • The client must have contract signing enabled. If the feature is disabled the request returns 403.

Path parameters

  • template_version_id (string, required) — the ID of the contract template version to preview. It must belong to your client.

Response

200 — Returns a ContractTemplatePreviewResponse:

  • mode — always "builder". The dashboard renders the preview through the embedded document builder.
  • file_type — the source document's file type (docx or pdf).
  • content_type — content type to use when rendering the preview content.
  • content_url — authenticated URL to load for inline-renderable previews. null for this endpoint.
  • builder_session — an embedded document-builder session containing template_id, signing_template_id, external_id, a short-lived token, and base_url (the browser host to embed the builder from, not the API origin).

Error responses

StatusWhen
400The template has not been provisioned for signing yet; the template is archived
403Contract signing is disabled for the client
404No template version with this ID exists under your client

Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.

Path Params
string
required
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json