Skip to main content
GET
/
qr-codes
/
{id}
/
image
Render a QR code image
curl --request GET \
  --url https://api.awardee.dev/v1/qr-codes/{id}/image \
  --header 'Authorization: Bearer <token>'
{
  "object": "<string>",
  "qr_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "public_slug": "<string>",
  "size": 0,
  "margin": 0,
  "encoded_url": "<string>",
  "data_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Send your API key as Authorization: Bearer aw_live_…. Manage keys in the dashboard under Settings → API Keys.

Path Parameters

​
id
string
required

A QR code's UUID or its public slug.

Query Parameters

​
format
enum<string>

Output format. Overrides the Accept header. Defaults to svg (or the negotiated Accept type).

Available options:
svg,
png,
pdf,
json
​
size
integer

Raster width in px (png). Nominal box for svg/pdf. 64–2000, default 512.

Required range: 64 <= x <= 2000
​
margin
integer

Quiet-zone width in modules. 0–20, default 4.

Required range: 0 <= x <= 20
​
ecl
enum<string>

Error-correction level. Default M.

Available options:
L,
M,
Q,
H
​
dark
string

Foreground color. Default #000000.

Pattern: ^#[0-9a-fA-F]{6}$
​
light
string

Background color. Default #ffffff.

Pattern: ^#[0-9a-fA-F]{6}$

Response

Rendered QR code. Media type depends on the requested format: image/svg+xml, image/png, or application/pdf for binary formats, or application/json (the qr_code_image schema) for format=json.

​
object
string
required
Allowed value: "qr_code_image"
​
qr_code_id
string<uuid>
required
​
public_slug
string
required
​
format
enum<string>
required
Available options:
svg,
png,
pdf,
json
​
size
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
margin
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
ecl
enum<string>
required
Available options:
L,
M,
Q,
H
​
encoded_url
string<uri>
required

The public scan URL encoded in the QR.

​
data_url
string
required

data:image/png;base64,… URL of the rendered QR.