QR Code Generator - API Contract

GET /api/v1/qr-codes/api/v1/qr-codes

List generated QR code records

Public

Response Example

{
  "data": [
    {
      "id": "qr_3c7f92",
      "url": "https://app.org.no/join?ref=JAN-VERV-8F3A",
      "size": 300,
      "error_correction_level": "M",
      "created_at": "2026-03-20T10:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 14
  }
}

GET /api/v1/qr-codes/api/v1/qr-codes/:id

Get a QR code record by ID

Public

Response Example

{
  "id": "qr_3c7f92",
  "url": "https://app.org.no/join?ref=JAN-VERV-8F3A",
  "size": 300,
  "error_correction_level": "M",
  "widget_data": "data:image/png;base64,iVBORw0KGgoAAAANSUhE...",
  "created_at": "2026-03-20T10:00:00Z"
}

POST /api/v1/qr-codes/api/v1/qr-codes

Build a QR widget for a referral URL (buildQrWidget)

Public

Request Example

{
  "url": "https://app.org.no/join?ref=JAN-VERV-8F3A",
  "size": 300,
  "error_correction_level": "M"
}

Response Example

{
  "id": "qr_3c7f92",
  "url": "https://app.org.no/join?ref=JAN-VERV-8F3A",
  "size": 300,
  "error_correction_level": "M",
  "widget_data": "data:image/png;base64,iVBORw0KGgoAAAANSUhE...",
  "created_at": "2026-03-26T12:00:00Z"
}

PUT /api/v1/qr-codes/api/v1/qr-codes/:id

Update QR code settings (setErrorCorrectionLevel)

Public

Request Example

{
  "error_correction_level": "H",
  "size": 400
}

Response Example

{
  "id": "qr_3c7f92",
  "url": "https://app.org.no/join?ref=JAN-VERV-8F3A",
  "size": 400,
  "error_correction_level": "H",
  "widget_data": "data:image/png;base64,iVBORw0KGgoAAAANSUhE...",
  "updated_at": "2026-03-26T12:05:00Z"
}

DELETE /api/v1/qr-codes/api/v1/qr-codes/:id

Delete a QR code record

Public

Response Example

{
  "id": "qr_3c7f92",
  "deleted": true,
  "deleted_at": "2026-03-26T12:10:00Z"
}

POST /api/v1/qr-codes/api/v1/qr-codes/export

Export QR code as image bytes (exportAsImageBytes)

Public

Request Example

{
  "url": "https://app.org.no/join?ref=JAN-VERV-8F3A",
  "size": 300
}

Response Example

{
  "url": "https://app.org.no/join?ref=JAN-VERV-8F3A",
  "size": 300,
  "format": "png",
  "image_base64": "iVBORw0KGgoAAAANSUhEUgAAAS...",
  "byte_size": 14832,
  "exported_at": "2026-03-26T12:00:00Z"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}