Build Dynamic QR Workflows with the QRLynx API
Create dynamic URL QR codes, repoint their destinations, read scan totals, and render SVG files from your own systems with scoped API keys.
Selected QR Code Type
A focused REST API for QRLynx dynamic URL codes
QRLynx API v1 lets Business and Enterprise accounts create dynamic URL QR codes, update their destination or name, read total and unique scans plus the last scan time, and render the stored short link as SVG. It uses bearer API keys with qr:read and qr:write scopes.
The API reuses the same QRLynx QR workflow as the dashboard. Destination validation, URL safety checks, account ownership, and the plan's dynamic QR limit still apply. Read the developer documentation, inspect the public OpenAPI 3.1 specification, or manage keys from Account API Keys.
What your integration can do
Four API operations cover creation, updates, reporting, and SVG delivery.
Create
POST a valid HTTP or HTTPS destination and optional name. The response includes the QR id, stored short URL, and SVG markup.
Repoint
PATCH the destination while keeping the same QR id and printed short link, or update the account-facing name.
Read Scan Totals
GET the QR detail with total scans, unique scans, last scanned time, current destination, short URL, and active status.
Render SVG
GET the QR SVG when your application needs scalable artwork generated from the stored QRLynx short link.
Limit Key Access
Choose read-only or read and write access, then revoke a key from the account without changing application users.
Reuse Product Safety
API creates and destination changes pass through QRLynx validation, safety scanning, ownership checks, and plan limits.
QRLynx API v1 endpoint map
Use the narrowest key scope that covers each operation.
| Endpoint | Scope | Result |
|---|---|---|
| POST /api/v1/qr | qr:write | Create a dynamic URL QR and return its id, destination, short URL, and SVG |
| GET /api/v1/qr/{id} | qr:read | Read allowlisted QR details and scan totals |
| PATCH /api/v1/qr/{id} | qr:write | Update the destination, name, or both |
| GET /api/v1/qr/{id}.svg | qr:read | Return image/svg+xml for the stored QR short link |
| GET /api/v1/openapi.json | Public | Return the OpenAPI 3.1 discovery document |
How to make the first QRLynx API request
Provision one scoped key, create a test QR, verify the response, and prepare the integration for production.
Use a Business or Enterprise workspace
API access begins on Business at $29 per month and is also included with Enterprise.
Create a named API key
An account owner or admin opens Account API Keys, gives the key a clear integration name, and chooses read-only or read and write access.
Copy the secret once
Store the qrl_live_ secret in a server-side secret manager when QRLynx displays it. The full value cannot be retrieved later.
Send a bearer-authenticated request
Call POST /api/v1/qr with application/json, a valid HTTP or HTTPS destination, and an optional name.
Save the returned identifiers
Keep the returned QR id and stored short URL with the record in your system. Use the returned SVG or request it again by id.
Test create, read, and repoint
Scan the generated QR, read its details, change the test destination with PATCH, and confirm the same QR reaches the new URL.
Operate with scoped keys
Use read-only keys for reporting jobs, reserve write keys for creation or repointing, monitor last use in QRLynx, and revoke retired keys.
Ready to automate a QR workflow
Review the API contract, then create a scoped key
Start with the endpoint examples and OpenAPI schema. Business and Enterprise accounts can create keys from the account workspace.
Keep API keys in server-side secrets
Send the key in the Authorization: Bearer qrl_live_... header from a trusted backend. QRLynx shows the full secret once, stores only its SHA-256 hash and a display prefix, and applies revocation, account status, current plan, and scope checks on each request.
Where the QR Code API fits
Use API v1 when another system owns the record and QRLynx supplies the managed QR layer.
Asset Management
Create a dynamic QR when a new asset record is approved, then store the QRLynx id and short URL beside it.
Print Operations
Render SVG artwork from a backend workflow and keep the same printed code when the destination changes.
Campaign Systems
Create named campaign QRs and repoint them when a promotion or landing page moves.
Internal Reporting
Use a read-only key to bring total scans, unique scans, and the last scan time into an internal report.
Current API v1 boundaries
Design the integration around the contract that is available today.
| Area | Current v1 contract | Planning note |
|---|---|---|
| QR type | Dynamic URL QR creation | Other dashboard QR types and GS1 Digital Link use their existing product workflows |
| Input | HTTP or HTTPS destination, optional name | Unknown JSON fields are rejected |
| Reporting | Total scans, unique scans, last scanned time | Use the account analytics experience for deeper dimensions |
| Automation model | Synchronous REST and JSON | Poll the read endpoint when a workflow needs current scan totals |
| Image output | SVG | Use dashboard downloads for other export formats |
| Ownership | The API key acts on its QRLynx owner workspace | Requests cannot read QR records from another workspace |
Connect your system to QRLynx dynamic QR codes
Use the public developer documentation to plan the request flow, then enable API access with Business or Enterprise.
QRLynx QR Code API questions
Answers about access, endpoints, keys, limits, output, and QR ownership.
Which QRLynx plans include API access?
API access is included with Business and Enterprise. Business starts at $29 per month. The free Starter plan, Starter+, and Pro use the dashboard and their included product workflows.
What can QRLynx API v1 create?
API v1 creates dynamic URL QR codes from a valid HTTP or HTTPS destination and an optional name. The response returns the QR id, destination, stored short URL, and SVG markup.
Can the API change a QR destination after printing?
Yes. Send PATCH /api/v1/qr/{id} with a new destination. QRLynx updates the managed destination while the QR id and printed short link remain the same.
Which scan data can the API return?
GET /api/v1/qr/{id} returns total scans, unique scans, the last scanned time, active status, current destination, short URL, name, type, and creation time.
How are QRLynx API keys authenticated?
Send the secret in an Authorization: Bearer qrl_live_... header. QRLynx stores the key as a SHA-256 hash, checks it live, and applies account, plan, expiry, creator-status, and scope controls.
What do qr:read and qr:write allow?
qr:read covers QR detail and SVG requests. qr:write covers create and repoint requests and also implies read access.
What are the API rate limits?
Current per-key limits are 120 reads, 60 creates, and 20 repoint operations per minute. A separate per-IP protection layer covers authentication traffic. QRLynx can tune these operational limits as usage data grows.
How do I revoke an API key?
An owner or admin opens Account API Keys and revokes the key. Authentication reads the live key record, so revocation applies on the next request.
Does API v1 return PNG, PDF, or SVG?
API v1 returns SVG, including SVG markup on create and image/svg+xml from GET /api/v1/qr/{id}.svg. Other download formats remain available through the QRLynx dashboard workflow.
Where is the machine-readable API definition?
The public OpenAPI 3.1 document is available at /api/v1/openapi.json. The /developers page provides authentication guidance, endpoint summaries, curl examples, errors, and plan access.
Continue with the developer resources
Use the QRLynx developer documentation for copy-ready requests, the OpenAPI 3.1 specification for tooling, and Dynamic URL QR Codes for the destination-management model behind repointing.