---
title: "A template with all its versions"
method: GET
path: "/templates/{ref}"
tags: ["Templates"]
---

# A template with all its versions

`GET /templates/{ref}`

## Request

- Base URL: `https://api.oveyon.com/v1`
- URL: `https://api.oveyon.com/v1/templates/{ref}`
- Auth: HTTP bearer

## Path parameters

- `ref` string, required

## Response `200`

Template

- Template: A template with all its versions.
  - `id` integer, required
  - `name` string, required
  - `currentVersion` integer, nullable, required: The version sends use; null = never published.
  - `createdAt` string, date-time, required
  - `versions` TemplateVersion[], required
    - `version` integer, required
    - `status` 'draft' | 'published', required: `published` is immutable.
    - `subject` string, required
    - `html` string, nullable, required
    - `text` string, nullable, required
    - `vars` TemplateVar[], required
      - `name` string, required: The ROOT of the path the template reads — the key to send in `data`: `{{pedido.total}}` and `{{#if pedido.pago}}` both declare `pedido` (send it as an object). Paths inside `{{#each}}` are relative to the item and are not listed.
      - `kind` 'var' | 'flag' | 'list', required: `var` = printed; `flag` = used in a condition; `list` = iterated by `{{#each}}`.
      - `required` boolean, required: true = a printed variable with no `| "default"`.
      - `default` string, nullable, required
    - `createdBy` string, nullable, required
    - `createdAt` string, date-time, required

## Other responses

- `401`: Missing or invalid API key.
- `403`: Insufficient scope (`insufficient_scope`, with `required` and `have`), a scope the key holds but cannot use while its human-approval lock is on (`scope_blocked_by_approval_lock`, with `required` — approve:holds, write:send-policies, manage:webhooks, write:inbound, write:templates, write:surveys, write:domains, write:contacts), API key switched off by its owner in the panel (`key_disabled` — the key is valid; turn it back on or use another one, do not rotate), sending disabled, account suspended (`account_suspended`) or unknown (`account_unknown`), or the key used from an IP outside its allowed ranges (`ip_not_allowed`, with the `allowed` list — see /v1/credentials/ip-rules). 403 is not a limit: do not retry.
- `404`: template_not_found
- `429`: Per-key limit (`rate_limited`, 600 requests/min by default per API key — or per MCP OAuth connection —, from any IP), per-IP limit for requests WITHOUT a valid credential (`rate_limited`, 600/min by default), too many unknown or malformed credentials from your address (`too_many_auth_failures`, 20/min by default, counted per IPv4 address or per IPv6 /48; a missing `Authorization`, an expired OAuth token or a disabled key do not count, and anything without the shape of one of our keys counts without being checked; from an address over that limit a valid key still gets through within 120 credential checks/min, and above them every credential not validated in the last 5 minutes gets this 429 until the minute turns) — all checked before the route, on every operation —, account quota (`quota_exceeded` with `window`, `used`, `limit`), warmup cap (`warmup_cap_reached`) or saturation (`queue_full`). Honor `Retry-After` with exponential backoff and jitter.
- `500`: internal_error — an unexpected failure on our side. The detail stays in our logs, never in the body. Retry reads; retry a write only when it is idempotent or carries an idempotency key.
- `503`: ip_rules_unavailable — the IP ranges bound to your key could not be checked right now (caution, not a denial). Retry after `Retry-After` (30 s).

---

[API](https://skmtc.dev/oveyon/apis/oveyon-api.md) · [All operations](https://skmtc.dev/oveyon/apis/oveyon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/oveyon/apis/oveyon-api/revisions/abf64c09d297?raw)