Get QR template

Overview

Get a single QR code template by its path ID, with the related store included. Returns 404 if the template does not belong to the authenticated user's company.

Prerequisites

• A bearer token. Callable with Account tokens.
• The templateId of the record you are targeting.

Base URL

Endpoint

GET /api/v1/qr-codes/template/{templateId}

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Account tokens.

• The lookup is scoped to the authenticated user's own company. A template belonging to any other company returns 404.

• There is no request body to validate. The {templateId} path segment is the only input, and the route constrains it to digits ([0-9]+).

Rate limit

• No rate limit.

Path parameters

Response

• data.status (string) — "success".
• data.data (object) — the QrCodeTemplate model, including id, name, description, store_id, template_type, design_html, design_settings, design_html_back, design_settings_back, qr_code_id, company_id, created_at, updated_at, and included store (id, name).
• data.message (string) — "QR code template retrieved successfully".

200 Success · 200

{
  "data": {
    "status": "success",
    "data": {
      "id": 10,
      "name": "Standard A6",
      "store_id": 8748,
      "template_type": "standard",
      "design_html": "<p>Example content</p>",
      "design_settings": {},
      "design_html_back": null,
      "design_settings_back": null,
      "qr_code_id": 1,
      "company_id": 456,
      "unique_code": "t9X8y7z6",
      "created_at": "2026-06-15T10:30:00.000000Z",
      "updated_at": "2026-06-15T10:30:00.000000Z",
      "store": { "id": 8748, "name": "Downtown Branch" }
    },
    "message": "QR code template retrieved successfully"
  }
}

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/qr-codes/template/123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'