Get QR Code

Retrieve a single QR code by its ID, including full content and design data.

GET/qr-codes/:id

Headers

Header	Required	Description
X-API-Key	Required	Your API key
QR-Version	Optional	API version (e.g., 2026-02-16)

Path Parameters

Parameter	Type	Description
id	string	The QR code ID (e.g., qr-aBc123XyZ9)

Response Fields

Top-level

Field	Type	Description
object	string	Object type, always "qr"
success	boolean	Whether the request succeeded

Data object

Field	Type	Description
id	string	Unique identifier for the QR code
name	string	User-defined name
type	string	QR code type (url, vCard, wifi, etc.)
content	object	The QR code content data (schema varies by type)
design	object	Design customization options. Try the Builder.
active	boolean	Whether the QR code is active
folder_id	string | null	Folder ID if the QR code is in a folder, otherwise null
folder_name	string | null	Folder name if the QR code is in a folder, otherwise null
short_url	string	The short URL that redirects when scanned
created_at	string	ISO 8601 creation timestamp
updated_at	string	ISO 8601 last update timestamp

Request

cURL

curl -X GET "https://integration-api.qr-build.com/qr-codes/qr-aBc123XyZ9" \
  -H "X-API-Key: qrb_live_your_api_key_here"

JavaScript

const response = await fetch(
  "https://integration-api.qr-build.com/qr-codes/qr-aBc123XyZ9",
  { headers: { "X-API-Key": "qrb_live_your_api_key_here" } }
);

const data = await response.json();

Python

import requests

response = requests.get(
    "https://integration-api.qr-build.com/qr-codes/qr-aBc123XyZ9",
    headers={"X-API-Key": "qrb_live_your_api_key_here"},
)

data = response.json()

Response

{
  "object": "qr",
  "success": true,
  "data": {
    "id": "qr-aBc123XyZ9",
    "name": "My Website QR",
    "type": "url",
    "content": {
      "url": "https://example.com"
    },
    "design": {
      "dots": { "style": "rounded", "color": "#6366f1" },
      "corners": { "style": "extra-rounded", "color": "#000000" },
      "corners_dot": { "style": "dot", "color": "#000000" },
      "background": { "color": "#ffffff" },
      "logo_url": null,
      "margin": 10
    },
    "active": true,
    "folder_id": "fld-aBc123XyZ9",
    "folder_name": "Marketing Campaign",
    "short_url": "https://qr-build.io/qr-aBc123XyZ9",
    "created_at": "2026-02-16T10:30:00Z",
    "updated_at": "2026-02-16T10:30:00Z"
  }
}

Error — Not Found

{
  "success": false,
  "error": {
    "code": "QR_NOT_FOUND",
    "message": "QR code not found"
  }
}