QR-Codes

​

Das QR-Code-Objekt

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "qrType": "website",
  "title": "Landing page",
  "description": null,
  "data": "https://getqr.sh/x7Kd2p1",
  "archived": false,
  "isStatic": false,
  "shortLink": "https://getqr.sh/x7Kd2p1",
  "domain": "getqr.sh",
  "key": "x7Kd2p1",
  "keyIsCustom": false,
  "url": "https://example.com",
  "ios": null,
  "android": null,
  "scans": 128,
  "access": {
    "passwordProtected": false,
    "activeAt": null,
    "pauseAt": null,
    "scanLimit": null
  },
  "designKind": "custom",
  "design": {
    "styles": { "dotsOptions": { "type": "rounded", "color": "#1E40AF" }, … },
    "frameOptions": { "id": "card", "text": "Scan me!", … },
    "logoOptions": { "type": "suggested", "id": "logo-website-3", "scalePercent": 25 }
  },
  "file": null,
  "appName": null,
  "pdfBundle": null,
  "imageGallery": null,
  "createdAt": "2026-08-01T10:00:00.000Z",
  "updatedAt": "2026-08-01T10:00:00.000Z"
}

​

QR-Codes auflisten

curl "https://getqr.com/api/v1/qrs?page=1&pageSize=100" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "data": [
    {
      "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
      "qrType": "website",
      "title": "Landing page",
      "shortLink": "https://getqr.sh/x7Kd2p1",
      "url": "https://example.com",
      "scans": 128,
      "…": "…"
    }
  ],
  "pagination": { "page": 1, "pageSize": 100, "total": 1, "hasMore": false }
}

​

QR-Code erstellen

curl -X POST "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: landing-page-2026-08" \
  -d '{
    "qrType": "website",
    "data": "https://example.com",
    "title": "Landing page",
    "access": { "scanLimit": 500 }
  }'

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "qrType": "website",
  "title": "Landing page",
  "data": "https://getqr.sh/x7Kd2p1",
  "shortLink": "https://getqr.sh/x7Kd2p1",
  "url": "https://example.com",
  "scans": 0,
  "access": { "passwordProtected": false, "activeAt": null, "pauseAt": null, "scanLimit": 500 },
  "…": "…"
}

​

Wiederholungen und Duplikate

• Mit Schlüssel. Mit einem Idempotency-Key-Header wird die Antwort 24 Stunden lang erneut ausgeliefert.
• Ohne Schlüssel. Ein identischer Body, der innerhalb von 30 Sekunden gesendet wird, gilt als Duplikat.
• Wiederholungen. Eine Wiederholung liefert die gespeicherte Antwort mit x-idempotent-replay: true. Ein neuer QR-Code liefert false.
• Laufende Anfrage. Eine zweite Anfrage, während die erste noch läuft, erhält 409 conflict.
• Fehlschläge. Eine fehlgeschlagene Erstellung gibt den Schlüssel sofort frei, sodass Sie es mit demselben Schlüssel erneut versuchen können.
• Ohne Garantie. Ist der Schutzmechanismus nicht verfügbar, werden Erstellungen ungeschützt ausgeführt.

​

QR-Code abrufen

curl "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf" \
  -H "Authorization: Bearer $GETQR_API_KEY"

​

QR-Code aktualisieren

• templateId. Wird nicht akzeptiert.
• link. Teilweise. Das aktuelle Ziel bleibt erhalten, wenn Sie link.url weglassen. link.domain und link.key erhalten 422: Der Kurzlink ist das, was der gedruckte Code kodiert. Erstellen Sie für einen anderen Kurzlink einen neuen QR-Code.
• data. Wird nur dann gegen den resultierenden Typ geprüft, wenn sich data oder qrType ändert. Ein Wechsel von qrType ohne passende data wird abgelehnt. Siehe Typwechsel.
• Design. styles, frameOptions und logoOptions werden mit dem gespeicherten Design zusammengeführt, sodass ein Teilobjekt nur ändert, was es nennt. Ein anderes Logo ersetzt das bisherige, behält aber dessen Größe.
• access. Jeder Schlüssel wird übernommen, wenn er vorhanden ist. null entfernt eine Regel. Zugriffsregeln gehören unter access: Wer sie unter link sendet, erhält 422.
• archived. Pausiert oder reaktiviert den QR-Code und seinen Kurzlink gemeinsam, wie Pausieren und Reaktivieren.

curl -X PATCH "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Autumn campaign",
    "access": { "password": "s3cr3t", "passwordProtected": true }
  }'

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "title": "Autumn campaign",
  "access": { "passwordProtected": true, "activeAt": null, "pauseAt": null, "scanLimit": null },
  "…": "…"
}

​

Pausierungsstatus festlegen

curl -X PUT "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "archived": true }'

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "archived": true,
  "…": "…"
}

​

QR-Code pausieren

curl -X POST "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf/pause" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "archived": true,
  "…": "…"
}

​

QR-Code reaktivieren

curl -X POST "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf/activate" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "archived": false,
  "…": "…"
}

​

QR-Code duplizieren

• Kurzlink. Die Kopie erhält einen eigenen Kurzlink mit zufälligem Slug auf der Standarddomain des Workspace, nicht auf der Domain des Originals. Ihre Scans werden getrennt gezählt.
• Titel. Der Titel erhält das Suffix (Copy). Das Ergebnis bleibt innerhalb von 40 Zeichen: Ein langer Titel wird vorher gekürzt. Ein QR-Code ohne Titel bleibt ohne Titel.
• Nicht kopiert. Zugriffsregeln (Passwort, Zeitplan, Scan-Limit) und der Pausierungsstatus. Die Kopie ist immer aktiv.
• Dateien. PDF- und Bilddateien, auch die von Bundles und Galerien, werden kopiert, sodass sie der Kopie gehören. Videodateien und Designdateien wie Logos teilt die Kopie mit dem Original.

curl -X POST "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf/duplicate" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "id": "qr_7Hk2PqWmX9cTnV4sLbR8YdZe",
  "title": "Landing page (Copy)",
  "shortLink": "https://getqr.sh/p2Wq9dL",
  "url": "https://example.com",
  "archived": false,
  "scans": 0,
  "…": "…"
}

​

QR-Code löschen

curl -X DELETE "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{ "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf", "deleted": true }

​

QR-Code-Bild herunterladen

• Body. Der Antwort-Body ist die Datei. Der vorgeschlagene Dateiname steht im Content-Disposition-Header. Er wird aus dem Titel gebildet, bei einem QR-Code ohne Titel lautet er qr-code.
• Caching. Antworten enthalten einen ETag und Cache-Control: private, max-age=3600, must-revalidate. Senden Sie den ETag in If-None-Match zurück, um 304 Not Modified zu erhalten, wenn sich der QR-Code nicht geändert hat.
• Fehler. Ein nicht unterstütztes Format oder eine nicht unterstützte Auflösung erhält 400 bad_request. Die Fehlermeldung nennt den Grund: qr_download_invalid_format, qr_download_invalid_resolution, qr_download_art_format_unsupported oder qr_download_art_resolution_unsupported.

curl "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf/download?format=png&resolution=1024" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  --output qr-code.png

HTTP/1.1 200 OK
Content-Type: image/png
Content-Disposition: attachment; filename="landing-page-1024px.png"
ETag: "9f2c0e1b5a7d43c8b016e2f4a9d5c3718be40f92"
Cache-Control: private, max-age=3600, must-revalidate

<binary image data>

​

Zugriffsregeln

​

Design-Objekte

​

Häufige Probleme

​

Wie geht es weiter?