Plantillas

Obtener una plantilla

GET/templates/{id}

Una plantilla: su versión guardada en Markdown, con un token {{Etiqueta}} donde un campo está vacío, y el inventario de campos del que se construye un formulario o un mapeo de campos, cada entrada con la clave que enviar y la etiqueta que mostrar.

Parámetros

Nombre	Tipo	Descripción
`id`obligatorio	uuid	El id de la plantilla.

Petición

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

Respuesta

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 — La versión guardada. Un campo vacío aparece como {{Etiqueta}}.
html — Una vista previa HTML fiel al papel de la versión guardada; html_truncated indica si se recortó por tamaño.
placeholders — Campos de nivel superior, una entrada por campo: key (por lo que se indexa values), label (el nombre legible), count (cuántos lugares rellena), value (el valor predeterminado), type (text, select, number, date, today o counter) y, cuando están definidos, options, format, description, auto y start.
groups — Grupos repetibles: key, label y fields, donde fields enumera exactamente las claves que un objeto de instancia puede llevar, cada una con la misma forma que un campo más un valor predeterminado.
generation_count — Cuántos documentos se han generado a partir de ella.