---
title: "The backend-owned template variable catalog: every {{token}} the render pipeline knows, with label, description, applicable template types, and the sample value previews use. The editor's variable picker and autocomplete derive from this."
method: GET
path: "/templates/variables"
tags: ["Templates"]
---

# The backend-owned template variable catalog: every {{token}} the render pipeline knows, with label, description, applicable template types, and the sample value previews use. The editor's variable picker and autocomplete derive from this.

`GET /templates/variables`

## Request

- Base URL: `https://api.clinicos.vet/backend/business`
- URL: `https://api.clinicos.vet/backend/business/templates/variables`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/docs/templates/variables/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `type` string
- `category` string

## Response `200`

OK

- TemplateVariableDto[]
  - `name` string: The token between the braces, e.g. "patient_name".
  - `tag` string: The full insertable token, e.g. "{{patient_name}}".
  - `label` string: Human-readable name shown in the editor's variable picker.
  - `description` string
  - `types` string[]: Template types whose render path populates this variable. Empty for legacy variables no current render path populates.
  - `sampleValue` string, nullable: Realistic value substituted in editor previews.
  - `categories` string[], nullable: Client-message categories this variable is offered for (type "client-message" only). Null means every category.
  - `smsSafe` boolean: Short enough to offer in an SMS body (ITE-1589).

## Changes

- **2026-10-28** `099cf36186e0`: 7 info
  - added the new optional `query` request parameter `category`
  - added the optional property `items/categories` to the response with the `200` status (media type: text/plain)
  - added the optional property `items/categories` to the response with the `200` status (media type: application/json)
  - added the optional property `items/categories` to the response with the `200` status (media type: text/json)
  - …3 more

[Operation history](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/changes/templates/variables/get.md)

---

[API](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1.md) - [All operations](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/revisions/099cf36186e0?raw)