Skip to content

Get started

Introduction

The API manages dynamic QR codes: create them, repoint them, pause them, render them and read their scan counts. Every code encodes a short link, so the printed image keeps working through every edit. Base URL:

https://qr-tool-five.vercel.app/api/v1

Requests and responses are JSON. Success responses wrap the payload in { "data": … }; failures return { "error": { "code", "message" } }.

1. Get an API key#

Create a key in the dashboard under API. Keys need a paid plan (Starter and up) or an active Pro trial, and a verified email. The full key shows once, at creation. Details: Authentication.

2. Create your first code#

# Create a code

curl -X POST https://qr-tool-five.vercel.app/api/v1/codes \
  -H "Authorization: Bearer qrf_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "First code", "destination": "https://example.com"}'

HTTP 201
{ "data": { "id": "4a38…", "name": "First code", "type": "url",
  "destination": "https://example.com", "slug": "aB3xY9k",
  "short_url": "https://qr-tool-five.vercel.app/r/aB3xY9k", "status": "active",
  "scans": 0, "created_at": "2026-07-19T14:58:09.915Z" } }

3. Scan it#

Render the image with the image endpoint and point a phone camera at it. The scan lands in your dashboard within seconds, and scans on the code increments. Change destination with a PATCH and scan again: same image, new target. That is the whole product.

Where to go next#