API reference

API explorer

Pick an endpoint, fill in its parameters and see the exact request in cURL, JavaScript and Python. With your own API key you can also send it and read the real response.

Requests here are live

QRBold has no sandbox. A request you send from this page acts on the real account your key belongs to: a POST creates a real card or code, a DELETE removes one. Nothing is sent until you press Send.

Endpoint

GET/qr-codes/ID/image

Returns the rendered QR image for a QR code or a digital business card. Needs the qr:read or cards:read scope.

Path parameters

id (required)

A QR code id or a card id.

Query parameters

format (optional)

File format. svg and pdf stay sharp at any print size.

size (optional)

Width in pixels, 128 to 4096. A framed code is taller than it is wide. pdf is one page at 300 dpi.

transparent (optional)

true leaves the background clear. png, webp and svg only.

download (optional)

true answers with Content-Disposition: attachment so a browser saves the file.

The code for this request

Updates as you type. It reads the key from an environment variable; the key you paste below is never put into it.

curl "https://api.qrbold.com/api/public/v1/qr-codes/ID/image?format=png&size=1024" \
  -H "Authorization: Bearer $QRBOLD_API_KEY" \
  --output qr.png

Send it from this browser

Your API key

Kept in this page’s memory only, and sent only to the QRBold API in the Authorization header. It is not stored, not logged and not sent to any other server. Reloading the page clears it. Use a key with only the scopes you need, and revoke it afterwards if you created it for testing.

Paste an API key to send the request.

You do not need a key to use the explorer as a request builder. If you would rather work in a dedicated tool, download the Postman collection. New here? Start with the quickstart.