QR Hero Developer Docs

Developer platform

Build on QR Hero

QR Hero exposes a versioned JSON REST API at /v1 and a Model Context Protocol (MCP) tool layer over the same services, permissions, and rate limits. Both surfaces are plan-gated via the api_access feature and authenticated with organization-scoped Sanctum personal access tokens.

Get started API reference

27

REST endpoints

25

MCP tools

5

Code sample languages

What ships today

  • 27 REST endpoints — status, organization, analytics, brands, domains, QR codes (including bulk import), styles, wallet, and token management.
  • 25 MCP tools — generated from the live MCP server tool classes with JSON Schema input definitions.
  • OpenAPI 3.1 spec — typed schemas and field-accurate examples (openapi.json).
  • Per-organization rate limits — platform ceiling plus plan-specific limits; 429 responses include Retry-After.
  • Usage metering — billable operations recorded in api_usage; overage draws from the prepaid wallet.

Intentionally excluded from API/MCP

Account-detail changes (name, email, password, billing address) and wallet/payment writes remain dashboard-only. Create tokens in the dashboard or via the POST /v1/tokens endpoint when your token has the api.tokens.manage ability.

Explore the docs

  1. Quickstart — create a token at /settings/api-tokens and make your first request.
  2. API reference — every endpoint with cURL, JavaScript, Python, PHP, and C# examples plus typed schemas.
  3. Token abilities — what each ability grants on REST and MCP.
  4. MCP tool catalog — all 25 tools with schemas, client setup, and examples.
  5. Rate limits — platform defaults, per-plan ceilings, raw export bucket, and metering.
  6. Design tool integrations — how the Figma and Canva plugins authenticate, and exactly what a connection can reach.