Skip to content

Templates

The engine ships with a curated set of templates: pre-baked QrConfig objects you call by id. Use them when you want a guaranteed-good visual and don't need to handcraft anything.

List templates

GET /api/qr/templates
{
  "success": true,
  "count": 118,
  "templates": [
    {
      "id": "champagne-onyx",
      "name": "Champagne on Onyx",
      "category": "luxury",
      "tags": ["dark", "monogram", "premium"],
      "preview": "https://api.qr-branding.com/api/qr/templates/champagne-onyx/preview"
    },
    { "...": "..." }
  ]
}

Filter by category

GET /api/qr/templates?category=luxury

The response shape is identical to the unfiltered call but only includes matches. Categories are case-insensitive and match the category field on each template. See the live list at /examples tab "Templates".

Generate from a template

POST /api/qr/templates/{templateId}

The body is a subset of QrConfig — anything you set overrides the template defaults. Most callers only override content, outputWidth and fileFormat.

Common overrides

FieldWhy you'd override it
contentThe URL or text to encode — almost always overridden
outputWidthPrint resolution (1200, 2400, 4096)
fileFormatpdf or svg for print, png for screen
logoUrlDrop your logo on top of any template
centerTextAdd a "ADMIT ONE" / "SCAN ME" banner
ctaTextCaption below

Every template rendered side-by-side is at /examples — the same gallery is also bundled into the visual reference for offline inspection.