Get QR code

Overview

Get a single QR code by ID, including its destination, customization and image URL. The QR code must belong to your own account. One belonging to another account is treated as not found rather than forbidden, so the response never reveals whether that ID exists.

Prerequisites

• A bearer token in the Authorization header.
• The qrCodeId of the record you are targeting.

Base URL

Endpoint

GET /api/v1/qr-codes/{qrCodeId}

Authentication

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

• Account — The endpoint scopes results to the caller's own account automatically; there is no parameter to query another account.

Rate limit

• No rate limit. This endpoint is a single indexed read, so it is not throttled — but treat it as a normal API call and cache the result rather than polling it.

Path parameters

How it works

• 200 returns status, message, and data — the QR code with its company, store, landingPage and reviewSite relations, plus the generated qr_code_image_url.
• 401 when the bearer token is missing or invalid.
• 404 QR code not found when no QR code with that ID exists in your account.
• 500 on an unexpected server error.

Response

200 Success · 200

{
  "data": {
    "status": "success",
    "data": {
      "id": 200,
      "name": "Front desk",
      "company_id": 412,
      "store_id": 8748,
      "destination_type": "landing_page",
      "landing_page_id": 1,
      "review_site_id": null,
      "destination_url": "https://example.com/lp/1?store_id=8748",
      "customization": null,
      "qr_code_image_path": "qr-codes/abc.png",
      "unique_code": "a1B2c3d4",
      "qr_code_image_url": "https://s3.example.com/qr-codes/abc.png",
      "last_scanned_at": "2026-06-15T10:30:00.000000Z",
      "company": { "id": 412, "name": "Acme Brand" },
      "store": { "id": 8748, "name": "Downtown" },
      "landing_page": { "id": 1 },
      "review_site": null
    },
    "message": "QR code retrieved successfully"
  }
}

Errors

Example request

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