Skip to main content

API Reference (v1)

The QRForge Public API v1 is defined in an OpenAPI 3.0 specification and exposed via HTTPS under the api.qrforge.link domain.

This page gives you a high-level map of the available resources and links to the machine-readable spec.

Base URL (Production)
https://api.qrforge.link

Specification (OpenAPI 3.0.3)
https://developer.qrforge.link/openapi/qrforge-v1.yaml

Resources​

Projects​

Projects are workspaces for organizing QR codes.

  • POST /v1/projects
    Create a new project for the authenticated user.

  • GET /v1/projects
    List projects for the authenticated user (paginated).

See: Projects

QR Codes​

Dynamic QR codes with redirect logic and analytics.

  • POST /v1/qr-codes
    Create a new QR code in a project.

  • GET /v1/qr-codes
    List QR codes (optional filters by project_id, status).

  • GET /v1/qr-codes/{id}
    Get a single QR by its ID.

  • PATCH /v1/qr-codes/{id}
    Update mutable fields (label, redirect_url, status).

  • GET /v1/qr-codes/by-slug?slug=…
    Get a QR by its public slug.

See: QR Codes

Authentication & API Keys​

All endpoints require a live API key.

x-api-key: api_live_***************

For more details on how to authenticate and operate safely against the API, see: