{"name":"Max QR Code API","version":"v1","docs":{"openapi":"/api/v1/openapi.json","marketing":"https://getmaxqr.com/docs","markdown":"See docs/API.md in the repository"},"auth":{"user":"Authorization: Bearer <supabase_access_token>","api_key":"Authorization: Bearer mq_live_… or X-Api-Key: mq_live_…","api_keys_plan":"business","scopes":["generate","dynamic","bulk","projects","analytics","manage"],"default_scopes":["generate","dynamic"]},"rate_limit":{"headers":["X-RateLimit-Limit","X-RateLimit-Remaining","X-RateLimit-Reset","Retry-After"],"guest_per_minute":30,"user_jwt_per_minute":600,"plans":[{"id":"free","api_requests_per_minute":30,"api_keys":false},{"id":"pro","api_requests_per_minute":300,"api_keys":false},{"id":"business","api_requests_per_minute":1000,"api_keys":true}]},"errors":{"shape":{"error":{"code":"string","message":"string","request_id":"uuid?"}}},"endpoints":[{"method":"GET","path":"/api/health","auth":"none","summary":"Liveness + storage stats"},{"method":"GET","path":"/api/ready","auth":"none","summary":"Readiness (disk + Supabase)"},{"method":"GET","path":"/api/v1","auth":"none","summary":"API catalog"},{"method":"GET","path":"/api/v1/openapi.json","auth":"none","summary":"OpenAPI 3 document"},{"method":"GET","path":"/api/v1/generate/options","auth":"none","summary":"QR engine options"},{"method":"POST","path":"/api/v1/generate","auth":"optional","summary":"Generate static QR (guest OK)","scope":"generate"},{"method":"POST","path":"/api/v1/generate/upload","auth":"optional","summary":"Generate with multipart logo","scope":"generate"},{"method":"POST","path":"/api/v1/generate/preview","auth":"optional","summary":"Preview QR (JSON)","scope":"generate"},{"method":"GET","path":"/api/v1/billing/status","auth":"none","summary":"Premium / Stripe / email status"},{"method":"GET","path":"/api/v1/billing/plans","auth":"none","summary":"Plan catalog"},{"method":"GET","path":"/api/v1/billing/me","auth":"user","summary":"Current user plan"},{"method":"GET","path":"/api/v1/billing/workspaces/:workspaceId","auth":"user","summary":"Workspace billing + credits"},{"method":"GET","path":"/api/v1/billing/workspaces/:workspaceId/credits","auth":"user","summary":"Credit packs / WL flag"},{"method":"POST","path":"/api/v1/billing/workspaces/:workspaceId/checkout","auth":"user","summary":"Stripe Checkout (premium on)"},{"method":"POST","path":"/api/v1/billing/workspaces/:workspaceId/credits/checkout","auth":"user","summary":"Credit pack Checkout (premium on)"},{"method":"POST","path":"/api/v1/billing/workspaces/:workspaceId/portal","auth":"user","summary":"Stripe Customer Portal"},{"method":"POST","path":"/api/v1/billing/webhook","auth":"stripe","summary":"Stripe webhooks (raw body)"},{"method":"GET","path":"/api/v1/me","auth":"user","summary":"Profile + workspaces"},{"method":"PATCH","path":"/api/v1/me","auth":"user","summary":"Update profile / preferences"},{"method":"GET","path":"/api/v1/workspaces","auth":"user","summary":"List workspaces"},{"method":"POST","path":"/api/v1/workspaces","auth":"user","summary":"Create workspace"},{"method":"GET","path":"/api/v1/workspaces/:id","auth":"user","summary":"Get workspace"},{"method":"POST","path":"/api/v1/workspaces/:id/transfer","auth":"user","summary":"Transfer ownership"},{"method":"GET","path":"/api/v1/workspaces/:id/api-keys","auth":"user","summary":"List API keys (Business)"},{"method":"POST","path":"/api/v1/workspaces/:id/api-keys","auth":"user","summary":"Create API key (Business)"},{"method":"DELETE","path":"/api/v1/workspaces/:id/api-keys/:keyId","auth":"user","summary":"Revoke API key"},{"method":"POST","path":"/api/v1/workspaces/:id/api-keys/:keyId/rotate","auth":"user","summary":"Rotate API key"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/projects","auth":"user|api_key","scope":"projects","summary":"List projects"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/projects","auth":"user|api_key","scope":"projects","summary":"Create project"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/projects/:projectId","auth":"user|api_key","scope":"projects","summary":"Get project"},{"method":"PATCH","path":"/api/v1/workspaces/:workspaceId/projects/:projectId","auth":"user|api_key","scope":"projects","summary":"Update project"},{"method":"DELETE","path":"/api/v1/workspaces/:workspaceId/projects/:projectId","auth":"user|api_key","scope":"projects","summary":"Archive / hard-delete project"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/projects/:projectId/duplicate","auth":"user|api_key","scope":"projects","summary":"Duplicate project"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/projects/:projectId/versions","auth":"user|api_key","scope":"projects","summary":"List project versions"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/projects/:projectId/versions/:version/restore","auth":"user|api_key","scope":"projects","summary":"Restore project version"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/projects/:projectId/render","auth":"user|api_key","scope":"projects","summary":"Render project QR"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/projects/:projectId/assets/logo","auth":"user|api_key","scope":"projects","summary":"Upload project logo"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/projects/:projectId/assets/:kind","auth":"user|api_key","scope":"projects","summary":"Download project logo or preview"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/brand-assets","auth":"user|api_key","scope":"projects","summary":"List brand assets"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/brand-assets","auth":"user|api_key","scope":"projects","summary":"Upload brand asset"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/brand-assets/:assetId","auth":"user|api_key","scope":"projects","summary":"Download brand asset"},{"method":"DELETE","path":"/api/v1/workspaces/:workspaceId/brand-assets/:assetId","auth":"user|api_key","scope":"projects","summary":"Delete brand asset"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/dynamic-codes","auth":"user|api_key","scope":"dynamic","summary":"List dynamic codes (Pro+)"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/dynamic-codes","auth":"user|api_key","scope":"dynamic","summary":"Create dynamic code (Pro+)"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/dynamic-codes/:codeId","auth":"user|api_key","scope":"dynamic","summary":"Get dynamic code"},{"method":"PATCH","path":"/api/v1/workspaces/:workspaceId/dynamic-codes/:codeId","auth":"user|api_key","scope":"dynamic","summary":"Update dynamic code"},{"method":"DELETE","path":"/api/v1/workspaces/:workspaceId/dynamic-codes/:codeId","auth":"user|api_key","scope":"dynamic","summary":"Delete dynamic code"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/dynamic-codes/:codeId/activate","auth":"user|api_key","scope":"dynamic","summary":"Activate code"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/dynamic-codes/:codeId/deactivate","auth":"user|api_key","scope":"dynamic","summary":"Deactivate code"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/bulk-jobs","auth":"user|api_key","scope":"bulk","summary":"List bulk jobs (Business)"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/bulk-jobs","auth":"user|api_key","scope":"bulk","summary":"Enqueue bulk job (Business)"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/bulk-jobs/:jobId","auth":"user|api_key","scope":"bulk","summary":"Get bulk job"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/bulk-jobs/:jobId/download","auth":"user|api_key","scope":"bulk","summary":"Download ZIP"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/bulk-jobs/:jobId/mapping","auth":"user|api_key","scope":"bulk","summary":"Download mapping CSV"},{"method":"DELETE","path":"/api/v1/workspaces/:workspaceId/bulk-jobs/:jobId","auth":"user|api_key","scope":"bulk","summary":"Cancel / delete job"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/analytics/codes/:codeId","auth":"user|api_key","scope":"analytics","summary":"Code analytics (Pro+)"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/analytics/codes/:codeId/csv","auth":"user|api_key","scope":"analytics","summary":"Export scans CSV"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/analytics/compare","auth":"user|api_key","scope":"analytics","summary":"Compare codes"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/domains","auth":"user","summary":"List custom domains (Business)"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/domains","auth":"user","summary":"Add custom domain"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/domains/:domainId","auth":"user","summary":"Get domain"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/domains/:domainId/verify","auth":"user","summary":"Verify DNS"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/domains/:domainId/primary","auth":"user","summary":"Set primary domain"},{"method":"DELETE","path":"/api/v1/workspaces/:workspaceId/domains/:domainId","auth":"user","summary":"Delete domain"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/members","auth":"user","summary":"List members (Business seats)"},{"method":"PATCH","path":"/api/v1/workspaces/:workspaceId/members/:userId","auth":"user","summary":"Change member role"},{"method":"DELETE","path":"/api/v1/workspaces/:workspaceId/members/:userId","auth":"user","summary":"Remove member"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/members/leave","auth":"user","summary":"Leave workspace"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/invites","auth":"user","summary":"List invites"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/invites","auth":"user","summary":"Create invite"},{"method":"DELETE","path":"/api/v1/workspaces/:workspaceId/invites/:inviteId","auth":"user","summary":"Revoke invite"},{"method":"POST","path":"/api/v1/invites/accept","auth":"user","summary":"Accept invite"},{"method":"GET","path":"/api/v1/invites/:token/preview","auth":"user","summary":"Preview invite"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/campaigns","auth":"user","summary":"List campaigns"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/campaigns","auth":"user","summary":"Create campaign"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/campaigns/bulk","auth":"user","summary":"Bulk update campaign status"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/campaigns/folders","auth":"user","summary":"List folders"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/campaigns/folders","auth":"user","summary":"Create folder"},{"method":"PATCH","path":"/api/v1/workspaces/:workspaceId/campaigns/folders/:folderId","auth":"user","summary":"Update folder"},{"method":"DELETE","path":"/api/v1/workspaces/:workspaceId/campaigns/folders/:folderId","auth":"user","summary":"Delete folder"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/campaigns/tags","auth":"user","summary":"List tags"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/campaigns/tags","auth":"user","summary":"Create tag"},{"method":"DELETE","path":"/api/v1/workspaces/:workspaceId/campaigns/tags/:tagId","auth":"user","summary":"Delete tag"},{"method":"GET","path":"/api/v1/workspaces/:workspaceId/campaigns/:campaignId","auth":"user","summary":"Get campaign"},{"method":"PATCH","path":"/api/v1/workspaces/:workspaceId/campaigns/:campaignId","auth":"user","summary":"Update campaign"},{"method":"DELETE","path":"/api/v1/workspaces/:workspaceId/campaigns/:campaignId","auth":"user","summary":"Archive / hard-delete campaign"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/campaigns/:campaignId/codes","auth":"user","summary":"Attach dynamic codes"},{"method":"DELETE","path":"/api/v1/workspaces/:workspaceId/campaigns/:campaignId/codes/:codeId","auth":"user","summary":"Detach dynamic code"},{"method":"POST","path":"/api/v1/workspaces/:workspaceId/campaigns/:campaignId/duplicate","auth":"user","summary":"Duplicate campaign"},{"method":"GET","path":"/r/:slug","auth":"none","summary":"Public 302 redirect"},{"method":"GET","path":"/api/v1/r/:slug/status","auth":"none","summary":"Public code status (no destination)"}]}