{"openapi":"3.1.0","info":{"title":"Qorlie Business REST API","version":"1.0.0","description":"Programmatic management of editable QR codes, bulk CSV creation, and scan analytics for Qorlie Scan Pass and Business accounts. Authenticate using an API key (`X-API-Key: ql_live_...` or `Authorization: Bearer ql_live_...`).","contact":{"name":"Tailored Tidings LLC","email":"support@qorlie.com"}},"servers":[{"url":"https://api.qorlie.com"}],"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key"},"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/v1/qrs":{"get":{"summary":"List dynamic QR codes","responses":{"200":{"description":"Array of dynamic QR codes"}}},"post":{"summary":"Create a dynamic QR code","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["title","destinationUrl"],"properties":{"title":{"type":"string"},"destinationUrl":{"type":"string","format":"uri"},"customSlug":{"type":"string"},"utmParams":{"type":"object"},"password":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}}}}}},"responses":{"201":{"description":"Created dynamic QR code"}}}},"/api/v1/qrs/bulk":{"post":{"summary":"Bulk create dynamic QR codes via JSON array or CSV","responses":{"201":{"description":"Batch of created dynamic QR codes"}}}},"/api/v1/qrs/{id}":{"patch":{"summary":"Update destination, slug, UTM, password, expiry, archive status, or destination lock. Locked destinations require reauthToken from POST /api/auth/step-up. Short slugs are never recycled.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"destinationUrl":{"type":"string","format":"uri"},"destinationLocked":{"type":"boolean"},"reauthToken":{"type":"string","description":"Fresh su_… token required to unlock or change a locked destination"},"status":{"type":"string","enum":["active","archived"]}}}}}},"responses":{"200":{"description":"Updated dynamic QR code"},"401":{"description":"REAUTH_REQUIRED when link is locked"}}},"delete":{"summary":"Retire a link forever. The short slug is tombstoned and never reassigned; scanners see a neutral retired page.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Link retired; slug permanently claimed"}}}},"/api/v1/qrs/{id}/destination-history":{"get":{"summary":"Append-only destination change history for a link (who, when, old/new URL)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"DestinationChangeEntry[]"}}}},"/api/auth/step-up":{"post":{"summary":"Issue a short-lived re-auth token for unlocking or changing a locked destination","responses":{"200":{"description":"{ reauthToken, expiresAt }"}}}},"/api/import/bitly/preview":{"post":{"summary":"Preview Bitly CSV or access-token import into new Qorlie short links. Shows credit cost before confirm. Never claims bit.ly slugs.","responses":{"200":{"description":"Preview items + cost quote + sessionId"}}}},"/api/import/bitly/confirm":{"post":{"summary":"Confirm Bitly import. Dynamic links use credits; static_redirect is free. Returns Qorlie mapping + replace checklist.","responses":{"201":{"description":"Created mapping checklist"}}}},"/api/link-health/alerts":{"get":{"summary":"In-app link health alerts (dead destination, redirect domain change, domain expiry)","responses":{"200":{"description":"LinkHealthAlert[]"}}}},"/api/v1/analytics/account":{"get":{"summary":"Get account-wide QR scan analytics (series, unique scans, geo cities, tech, 7x24 heatmap, top codes)","parameters":[{"name":"range","in":"query","schema":{"type":"string","enum":["7d","30d","90d","custom"]}},{"name":"granularity","in":"query","schema":{"type":"string","enum":["day","week","month"]}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}},{"name":"compare","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Account analytics summary JSON"}}}},"/api/v1/analytics/account/export":{"get":{"summary":"Export account-wide scan analytics as CSV","responses":{"200":{"description":"text/csv report"}}}},"/api/v1/qrs/{id}/analytics":{"get":{"summary":"Get per-code scan analytics by day/week/month, country, city, OS, browser, referrer, and 7x24 heatmap","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"range","in":"query","schema":{"type":"string","enum":["7d","30d","90d","custom"]}},{"name":"granularity","in":"query","schema":{"type":"string","enum":["day","week","month"]}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}},{"name":"compare","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Analytics summary JSON"}}}},"/api/v1/qrs/{id}/analytics/export":{"get":{"summary":"Export scan analytics as CSV","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"text/csv report"}}}}}}