get
https://api-sandbox.urbanpayx.com/api/v1/contracts/templates/
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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
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.readpermission 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
| Parameter | Description |
|---|---|
template_version_id | ID 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 (nulluntil 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
| Status | When |
|---|---|
403 | Contract signing is disabled for the client |
404 | No 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.