Get Contract Template

Get contract template

Returns details for a specific contract template version, including detected fields,
signer roles, and variables.

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

Retrieve full details for a single contract template version owned by your client, including its current status, detected fields, signer roles, and any variable placeholders detected in the source document. This is a read-only lookup with no side effects.

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

ParameterDescription
template_version_idID of the contract template version to retrieve. Must belong to your client.

Response

200 with the template version. Notable fields:

  • id, name, external_id — identifiers for the template version.
  • status — current lifecycle status of the version.
  • file_type — file type of the source document.
  • signing_template_id, signing_template_slug — identifiers assigned by the signing provider once the template is provisioned (null until then).
  • source_file — the original uploaded source document.
  • roles — signer roles defined in the template.
  • fields — fields detected in the template.
  • detected_variables — variable placeholders detected in the template document (populated only for DOCX source documents whose source file is available; otherwise an empty list).
  • published_at, created_at, updated_at — lifecycle timestamps.

Error responses

StatusWhen
403Contract signing is disabled for the client
404No contract 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