Get Contract Template Preview Content

Get contract template preview content

Streams the original template file with an inline content disposition so the
frontend can render PDF previews directly in-browser.

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

Streams the original source file of a contract template version so the frontend can render an inline preview (for example, a PDF) directly in the browser. The response is the raw file bytes served with an inline content disposition, not a JSON payload.

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.
  • Contract signing must be enabled for the client. If it is disabled the request returns 403.

Path parameters

ParameterDescription
template_version_idThe ID of the contract template version to preview. Must belong to your client.

Response

  • 200 — Returns the raw template file as a binary stream.
  • The Content-Type reflects the stored source file (typically application/pdf for PDF templates or application/vnd.openxmlformats-officedocument.wordprocessingml.document for DOCX templates).
  • The response carries Content-Disposition: inline with the template's original filename, so browsers render it in place rather than forcing a download. It also sets X-Content-Type-Options: nosniff.

Error responses

StatusWhen
403Contract signing is disabled for the client
404Template version not found under this client, or its source file is missing or unreadable

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