Skip to content

QRLynx Developer API

Automate dynamic URL QR creation, destination updates, scan summaries and SVG output with scoped API keys on Business and Enterprise.

Authentication

Generate a key in your account under API Keys. Send it as a bearer token on every request. The key acts on your account; keep it secret and never put it in a URL.

Authorization: Bearer qrl_live_...

Scopes: qr:read (read + render) and qr:write (create + repoint). The machine-readable API specification, including the request limits below, is available at /api/v1/openapi.json.

Request limits

Configured API request allowances
OperationAllowance
Read QR details or render SVG120 requests per API key per 60 seconds, shared across reads
Create a dynamic URL QR60 requests per API key per 60 seconds
Rename or update a destination20 requests per API key per 60 seconds, shared across updates
Additional IP backstop300 API requests per IP per 60 seconds, before key authentication

These budgets govern steady-state usage rather than guaranteeing an instantaneous burst allowance. Creating codes also uses your plan's active dynamic QR capacity. The public OpenAPI document requires no key and is exempt from the API-key authentication and its IP backstop.

Responses that pass through the per-key limiter include X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (the reset time in Unix seconds). An earlier IP rejection includes Retry-After without those per-key headers.

On 429, wait for the number of seconds in Retry-After before retrying. Queue requests and pace retries instead of repeating them immediately. The per-key error body also includes retryAfterSeconds.

Endpoints

Current type support: API v1 works with dynamic URL QR codes only. If an ID belongs to another type created in the dashboard, including GS1 Digital Link, the read, update, and SVG endpoints return 400 unsupported_type.

POST /api/v1/qr

Create a dynamic URL QR code. Returns its short link and the rendered SVG.

curl -X POST https://qrlynx.com/api/v1/qr \
  -H "Authorization: Bearer qrl_live_..." \
  -H "Content-Type: application/json" \
  -d '{"destination":"https://example.com/spring","name":"Spring flyer"}'

PATCH /api/v1/qr/{id}

Repoint an existing code (no reprint needed) or rename it.

curl -X PATCH https://qrlynx.com/api/v1/qr/{id} \
  -H "Authorization: Bearer qrl_live_..." \
  -H "Content-Type: application/json" \
  -d '{"destination":"https://example.com/summer"}'

GET /api/v1/qr/{id}

Read a code's details and scan counts.

GET /api/v1/qr/{id}.svg

Render the QR as an SVG image, generated on demand (nothing is stored).

Errors

Authentication, validation and workflow errors return a JSON body { "error": { "code": "..." } }. Validation and workflow errors also include a message, while authentication errors (401/403) return the code only. Standard statuses: 400 invalid request or unsupported QR type, 401 missing/invalid key, 402 plan limit reached, 403 insufficient scope or plan, 404 not found, 429 rate limited.

A per-key rate-limit response uses this body, with the actual wait time in seconds:

{"error":"Too many requests. Please slow down and try again.","retryAfterSeconds":60}

An earlier IP rate-limit response uses the error-code object:

{"error":{"code":"rate_limited"}}