Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/org-quicko/linq/llms.txt

Use this file to discover all available pages before exploring further.

linq generates QR codes that are permanently bound to a link’s short URL. Rather than storing the encoded URL directly, each QR code record stores only its visual styling — the actual URL encoded at render time is always the link’s current short URL. This means a single QR code entry can survive domain changes and stays consistent across every printed copy. A single link may have multiple QR codes, each with a different appearance for different use cases: print, digital, dark-mode, and so on.
Deleting a QR code removes only the saved styling record — the link and its redirect remain completely intact. QR codes are hard-deleted (no archive state), so once deleted they cannot be recovered. There is no purge lifecycle for QR codes.

​
Endpoints

List QR Codes

GET /api/v1/qr-codes

Create QR Code

POST /api/v1/qr-codes

Get QR Code

GET /api/v1/qr-codes/{id}

Update QR Code

PATCH /api/v1/qr-codes/{id}

Delete QR Code

DELETE /api/v1/qr-codes/{id}

​
List QR Codes

Returns a paginated list of QR codes, optionally scoped to a single link. Results are ordered newest-first. 
GET /api/v1/qr-codes

​
Query Parameters

​
link_id
string (UUID)
Filter results to QR codes belonging to a specific link. Omit to return QR codes across all links.
​
search
string
Case-insensitive substring search across the QR code name, the parent link’s name, and the parent link’s slug.
​
limit
integer
default:"50"
Maximum number of results per page. Must be between 1 and 200.
​
offset
integer
default:"0"
Zero-based index of the first result to return. Use with limit to paginate.

​
Response

Returns a list envelope: { data, total, limit, offset }. 
curl https://your-linq-host/api/v1/qr-codes?link_id=018f2c3e-1234-7abc-8def-000000000001 \
  -H "x-api-key: lq_your_key_here"

{
  "data": [
    {
      "id": "018f2c3e-0000-7000-8000-000000000002",
      "link_id": "018f2c3e-1234-7abc-8def-000000000001",
      "name": "Print Edition",
      "dot_color": "#1a1a2e",
      "bg_color": "#ffffff",
      "pattern": "rounded",
      "link_name": "Product Launch",
      "link_status": "active",
      "slug": "launch",
      "domain_host": "go.example.com",
      "short_url": "https://go.example.com/launch",
      "created_at": "2024-06-01T10:00:00.000Z",
      "updated_at": "2024-06-01T10:00:00.000Z"
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

​
Create QR Code

Creates a new QR code attached to an existing link. The link must be active — QR codes cannot be attached to archived links. 
POST /api/v1/qr-codes

​
Body Parameters

​
link_id
string (UUID)
required
The ID of the link this QR code encodes. Must reference an active link. A QR code can never be reassigned to a different link after creation — doing so would invalidate every printed copy.
​
name
string
An optional human-readable label for this QR code (max 120 characters). Useful when a link has multiple codes for different contexts.
​
dot_color
string
default:"\"#000000\""
The hex color for QR dots. Must be a 6-digit hex string, e.g. #1a1a2e. Defaults to black.
​
bg_color
string
default:"\"#ffffff\""
The hex color for the QR code background. Must be a 6-digit hex string. Defaults to white.
​
pattern
string
default:"\"squares\""
The visual pattern used to render QR dots. One of:
  • squares — standard square dots (default)
  • rounded — square dots with rounded corners
  • dots — circular dots

​
Response

Returns the created QR code object with HTTP 201 Created. 
curl -X POST https://your-linq-host/api/v1/qr-codes \
  -H "x-api-key: lq_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "link_id": "018f2c3e-1234-7abc-8def-000000000001",
    "name": "Print Edition",
    "dot_color": "#1a1a2e",
    "bg_color": "#ffffff",
    "pattern": "rounded"
  }'

​
Get QR Code

Retrieves a single QR code by its ID, including the parent link’s name, status, slug, and resolved short URL. 
GET /api/v1/qr-codes/{id}

​
Path Parameters

​
id
string (UUID)
required
The UUID of the QR code to retrieve.
curl https://your-linq-host/api/v1/qr-codes/018f2c3e-0000-7000-8000-000000000002 \
  -H "x-api-key: lq_your_key_here"

​
Update QR Code

Updates the visual style fields of a QR code. The link_id field is immutable and cannot be changed — re-pointing a QR code to a different link would invalidate every printed copy. 
PATCH /api/v1/qr-codes/{id}

​
Path Parameters

​
id
string (UUID)
required
The UUID of the QR code to update.

​
Body Parameters

All fields are optional. Only the fields you include will be updated.
​
name
string
Updated display name for the QR code (max 120 characters). Pass null to clear it.
​
dot_color
string
New hex color for QR dots. Must be a 6-digit hex string, e.g. #333333.
​
bg_color
string
New hex color for the QR code background.
​
pattern
string
Updated dot pattern. One of squares, rounded, or dots.
curl -X PATCH https://your-linq-host/api/v1/qr-codes/018f2c3e-0000-7000-8000-000000000002 \
  -H "x-api-key: lq_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "pattern": "dots", "dot_color": "#0066cc" }'

​
Delete QR Code

Permanently deletes a QR code record. The parent link and all its redirects are unaffected. This operation is irreversible. 
DELETE /api/v1/qr-codes/{id}

​
Path Parameters

​
id
string (UUID)
required
The UUID of the QR code to delete.
Returns 204 No Content on success. 
curl -X DELETE https://your-linq-host/api/v1/qr-codes/018f2c3e-0000-7000-8000-000000000002 \
  -H "x-api-key: lq_your_key_here"

​
QR Code Object

​
id
string
UUID (v7) uniquely identifying this QR code.
​
link_id
string
UUID of the parent link this QR code encodes.
​
name
string | null
Optional display label for this QR code.
​
dot_color
string
6-digit hex color used to render QR dots. Example: #000000.
​
bg_color
string
6-digit hex color used for the QR background. Example: #ffffff.
​
pattern
string
Dot pattern — one of squares, rounded, or dots.
​
link_name
string | null
The parent link’s display name, carried on the response so list views render without an extra request.
​
link_status
string
The parent link’s current status — active or archived.
​
slug
string
The slug component of the parent link’s short URL.
​
domain_host
string
The hostname of the domain the parent link lives on.
​
short_url
string
The fully resolved short URL that this QR code encodes, e.g. https://go.example.com/launch.
​
created_at
string (ISO 8601)
Timestamp when this QR code was created.
​
updated_at
string (ISO 8601)
Timestamp of the last style update.

Build docs developers (and LLMs) love

Get started for freeTalk to us