Get Contract Template

Get contract template

Returns details for a specific contract template version, including
detected fields, signer roles, and variables. Returns 404 if the template
does not exist or belongs to a different client.

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. Archived and one-off (is_ad_hoc) templates are returned too. This is a read-only lookup with no side effects.

Authentication & access

  • Requires a client API token: Authorization: Bearer <token>.
  • API credentials need the contracts.templates.read permission. Dashboard users need the OWNER, OPERATIONS, or DEVELOPER role, or a custom role that includes this permission.
  • Contract signing must be enabled for the client. If it 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. New templates are published; an archived template is archived.
  • file_type - file type of the source document (pdf or docx).
  • is_ad_hoc - true for a one-off template uploaded for a single send.
  • signing_template_id, signing_template_slug - identifiers assigned by the signing service when the document is registered at upload (null if the template was never provisioned for signing).
  • source_file - the original uploaded source document.
  • roles - signer roles defined in the template.
  • fields - fields detected in the template.
  • detected_variables - variable placeholders ([[variable]]) in the template document. Only DOCX templates have them; for PDF templates this is an empty list. For a DOCX whose variables can be filled in on a send, the list comes from the signing service and reflects document builder edits once they have been fetched (by a refresh, or when a contract flow using the template is saved); otherwise it is read from the uploaded file (empty if that file is unavailable).
  • variables_fillable - whether [[variable]] placeholders can be filled in when this template is sent. It is false for a DOCX uploaded without placeholders (nothing to fill). If an older DOCX reports false but does contain placeholders, sending it returns 400 until you re-upload it.
  • 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