Vorlagen

Eine Vorlage abrufen

GET/templates/{id}

Eine Vorlage: ihre gespeicherte Version als Markdown, mit einem {{Bezeichnung}}-Token überall dort, wo ein Platzhalter leer ist, und das Platzhalter-Inventar, aus dem ein Formular oder eine Feldzuordnung entsteht, jeder Eintrag mit dem zu sendenden Schlüssel und der anzuzeigenden Bezeichnung.

Parameter

Name	Typ	Beschreibung
`id`erforderlich	uuid	Die ID der Vorlage.

Anfrage

curl https://usepaperclerk.com/api/v1/templates/4d1f0c2e-7b3a-4c1e-9d2f-1a2b3c4d5e6f \
  -H "Authorization: Bearer pc_YOUR_TOKEN"

Antwort

JSON

{
  "id": "4d1f0c2e-7b3a-4c1e-9d2f-1a2b3c4d5e6f",
  "title": "Consulting invoice",
  "markdown": "# Consulting invoice\n\nInvoice {{Invoice number}} for {{Client name}} …",
  "html": "<div class=\"doc-page\" …>…</div>",
  "html_truncated": false,
  "placeholders": [
    {
      "label": "Client name",
      "key": "client_name",
      "count": 2,
      "value": "",
      "type": "text",
      "description": "The client's legal name, not the contact person."
    },
    {
      "label": "Payment terms",
      "key": "payment_terms",
      "count": 1,
      "value": "Net 30",
      "type": "select",
      "options": [
        "Net 15",
        "Net 30",
        "Due on receipt"
      ]
    },
    {
      "label": "Due date",
      "key": "due_date",
      "count": 1,
      "value": "",
      "type": "date",
      "format": "08/27/2026"
    },
    {
      "label": "Invoice number",
      "key": "invoice_number",
      "count": 1,
      "value": "",
      "type": "counter",
      "auto": true,
      "format": "INV-0001",
      "start": 1
    },
    {
      "label": "Issue date",
      "key": "issue_date",
      "count": 1,
      "value": "",
      "type": "today",
      "auto": true,
      "format": "August 27, 2026"
    }
  ],
  "groups": [
    {
      "label": "Line items",
      "key": "line_items",
      "fields": [
        {
          "label": "Item",
          "key": "item",
          "type": "text"
        },
        {
          "label": "Quantity",
          "key": "quantity",
          "type": "number",
          "format": "1,234"
        },
        {
          "label": "Amount",
          "key": "amount",
          "type": "number",
          "format": "1,234.56"
        }
      ]
    }
  ],
  "generation_count": 12,
  "updated_at": "2026-09-10T09:14:03.201Z"
}

markdown — Die gespeicherte Version. Ein leerer Platzhalter erscheint als {{Bezeichnung}}.
html — Eine papiergetreue HTML-Vorschau der gespeicherten Version; html_truncated sagt, ob sie wegen der Größe gekürzt wurde.
placeholders — Platzhalter auf oberster Ebene, ein Eintrag pro Platzhalter: key (wonach values indiziert ist), label (der lesbare Name), count (wie viele Stellen er füllt), value (der Standardwert), type (text, select, number, date, today oder counter) und, sofern gesetzt, options, format, description, auto und start.
groups — Wiederholbare Gruppen: key, label und fields, wobei fields genau die Schlüssel auflistet, die ein Instanzobjekt tragen darf, jeder in derselben Form wie ein Platzhalter plus einem Standardwert.
generation_count — Wie viele Dokumente daraus erzeugt wurden.