get
https://api-sandbox.urbanpayx.com/api/v1/contracts/templates//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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
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.readpermission 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
| Parameter | Description |
|---|---|
template_version_id | The 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-Typereflects the stored source file (typicallyapplication/pdffor PDF templates orapplication/vnd.openxmlformats-officedocument.wordprocessingml.documentfor DOCX templates). - The response carries
Content-Disposition: inlinewith the template's original filename, so browsers render it in place rather than forcing a download. It also setsX-Content-Type-Options: nosniff.
Error responses
| Status | When |
|---|---|
403 | Contract signing is disabled for the client |
404 | Template 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.