Get one QR design

Overview

Get a design's settings.

Use this to load it for editing.

You'll need the template id (id in List QR designs).

Returns the design.

Prerequisites

A bearer token for the account. See Authentication.
The design's id (templateId), from List QR designs.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

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

Authentication

Account token

The design must have been created under your token's account; a design of any other account returns 404.

🚧
QR codes belong to the account that created them, and every QR endpoint matches on that account exactly; it doesn't walk the partner tree. A Partner token sees nothing, even for a location inside the partner's own tree: list endpoints return an empty result, and single-record endpoints return 404 QR code not found. The 404 means "not visible to this token", not "this QR code doesn't exist". Use an Account token for every endpoint in this section.

Rate limit

This endpoint has no rate limit.

Request parameters

Parameter	In	Type	Required	Description
`templateId`	path	integer	Yes	The design's id (`id` in List QR designs). Digits only.

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Field	Type	Description
`status`	string	`success`.
`data`	object	The design.
`data.id`	integer	The design's id. Use it as `templateId`.
`data.store_id`	integer	The location the design is for.
`data.company_id`	integer	The account that owns the design.
`data.name`	string	The design's name.
`data.description`	string or null	The design's description, or `null`.
`data.qr_code_id`	integer or null	The QR code the design is for, or `null`.
`data.template_type`	string	`standard`, `hangtag` or `custom`.
`data.design_settings`	object or null	Settings for the front of the design.
`data.design_html`	string or null	Markup for the front of the design.
`data.design_settings_back`	object or null	Settings for the back of the design.
`data.design_html_back`	string or null	Markup for the back of the design.
`data.metadata`	object or null	Extra data, or `null`.
`data.created_at`	string	When the design was created (ISO 8601).
`data.updated_at`	string	When the design was last changed (ISO 8601).
`data.deleted_at`	string or null	Always `null` here.
`data.unique_code`	string	The design's encoded id.
`data.store`	object or null	The location.
`data.store.id`	integer	The location's id.
`data.store.name`	string	The location's name.
`message`	string	`QR code template retrieved successfully`

Response payload

{
  "data": {
    "status": "success",
    "data": {
      "id": 2964,
      "store_id": 3008,
      "company_id": 5994,
      "name": "Default QR Code Template",
      "description": null,
      "qr_code_id": 2964,
      "template_type": "standard",
      "design_settings": {
        "logo": null,
        "title": "QR Code",
        "caption": "Scan the QR code to leave us a quick review.",
        "hideLogo": false,
        "subtitle": "Scan the QR code to learn more",
        "logoWidth": 150,
        "textColor": "#000000",
        "hideQrText": false,
        "titleColor": "#438bc7",
        "borderColor": "#ffffff",
        "logoBgColor": "#FFFFFF",
        "subtitleColor": "#000000",
        "backSameAsFront": true,
        "backgroundColor": "#e1ecf5",
        "dashedBorderColor": "#ffffff",
        "contentBackgroundColor": "#f6fafd",
        "hangTagBackgroundColor": "#336997"
      },
      "design_html": null,
      "design_settings_back": null,
      "design_html_back": null,
      "metadata": null,
      "created_at": "2026-09-23T11:28:45.000000Z",
      "updated_at": "2026-09-23T11:28:45.000000Z",
      "deleted_at": null,
      "unique_code": "1nwluo",
      "store": {
        "id": 3008,
        "name": "Acme Coffee - Circular Quay"
      }
    },
    "message": "QR code template retrieved successfully"
  }
}

Examples

Success payload

See Response payload.

Error payload

404 Not found

{
  "message": "QR code template not found",
  "status": "error",
  "errors": []
}

Status	Meaning
`200`	The design.
`401`	The token is missing, expired or invalid.
`404`	`QR code template not found`: the design wasn't created under your token's account, or has been deleted.
`500`	Unexpected server error.

Example request

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