QRnaly
Create Free QR
QRnaly Developer Docsv1.0 REST
API Keys Dashboard

REST API v1 Reference

Complete machine-readable public API specification for https://qrnaly.com/api/v1.

All Version 1.0 Endpoints

GET/api/v1/me

Get authenticated workspace identity, role, and active API scopes.

Scope: None
GET/api/v1/usage

Retrieve QR credit balance, dynamic concurrency caps, and rate limits.

Scope: None
GET/api/v1/qr

List all QR codes owned by the authenticated workspace.

Scope: qr:read
POST/api/v1/qr

Create a new static or dynamic QR code (consumes 1 QR Credit for dynamic).

Scope: qr:write
GET/api/v1/qr/:id

Retrieve full QR configuration, vector SVG download link, and metadata.

Scope: qr:read
PATCH/api/v1/qr/:id

Update destination URL of an existing dynamic QR code (0 credits charged).

Scope: qr:write
DELETE/api/v1/qr/:id

Archive or delete a QR code and deactivate its shortlink routing.

Scope: qr:write
GET/api/v1/documents

List all uploaded PDF menus, brochures, and images in workspace.

Scope: documents:read
POST/api/v1/documents

Register or upload a document to cloud storage (consumes 2 QR Credits).

Scope: documents:write
GET/api/v1/documents/:id

Retrieve document metadata, file size, and linked dynamic QR id.

Scope: documents:read
DELETE/api/v1/documents/:id

Purge document binary from cloud storage and remove QR links.

Scope: documents:write
GET/api/v1/analytics/:id

Retrieve 30-day scan telemetry, device/OS rollups, and city metrics.

Scope: analytics:read