---
title: "Read a blank template"
method: GET
path: "/templates/{key}"
tags: ["template"]
---

# Read a blank template

`GET /templates/{key}`

## Request

- Base URL: `https://localhost:4410/api/v1`
- URL: `https://localhost:4410/api/v1/templates/{key}`
- Auth: HTTP bearer

One form as its publisher released it: the blank text with each blank labelled, who drafted it, its license, source and hashes, what you can change and what it isn't built for.

## Path parameters

- `key` string, required

## Query parameters

- `version` string

## Response `200`

The result.

- object
  - `key` string, required
  - `version` string, required
  - `title` string, required
  - `source_name` string, required
  - `drafted_by` object, required
    - `text` string, required
    - `url` string, required
  - `license` object, required
    - `name` string, required
    - `url` string, required
    - `notice` string, required
  - `source_url` string, required
  - `checked_on` string, required
  - `jurisdiction` string, required
  - `review` string, required
  - `stability` string, nullable, required
  - `purpose` 'safe_board_consent', nullable, required
  - `fill_blanks_only` boolean, required
  - `you_can_change` string, required
  - `not_built_for` string[], required
  - `source_sha256` string, required
  - `bundled_sha256` string, required
  - `verbatim` boolean, required
  - `status` 'available' | 'withdrawn' | 'source_changed' | 'unreviewed', required
  - `unavailable` string, nullable, required
  - `withdrawn` object, nullable, required
    - `on` string, required
    - `reason` string, required
  - `rules` object[], required
    - `id` string, required
    - `citation` string, required
    - `url` string, required
    - `checked_on` string, required
  - `rule_changes` string[], required
  - `download_url` string, required
  - `notices` string[], required
  - `paragraphs` object[], required
    - `id` string, required
    - `pieces` union[], required
      - union
        - object
          - `id` string, required
          - `text` string, required
        - object
          - `id` string, required
          - `blank` string, required

## Other responses

- `default`: An RFC 9457 problem.

---

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