PixQR API
Create tracked QR codes from your CRM, e-commerce store, ticketing system or a Google Sheet, change where they point after printing, and read their scan statistics. Every link you send goes through the same safety checks as the studio.
1. Get an API key
- Sign in at https://pixqr.in and open Account and privacy.
- Under API keys, give the key a name and choose Create API key.
- Copy the key straight away — it starts with
pqk_and is shown only once.
Send it in the Authorization header of every request. Keep keys on your server; never put them in a website, mobile app or public repository. Revoke a key from the Account page at any time.
curl https://pixqr.in/api/v1/me \
-H "Authorization: Bearer pqk_xxxxxxxxxxxx_your-secret"
2. Create a tracked QR code
curl -X POST https://pixqr.in/api/v1/qr \
-H "Authorization: Bearer $PIXQR_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Store Ahmedabad", "url": "https://example.com/ahmedabad", "folder": "Stores"}'
Response 201:
{
"item": {
"id": "q3Xh8sLk2PaN",
"code": "Ab3dE7k",
"shortUrl": "https://pixqr.in/r/Ab3dE7k",
"name": "Store Ahmedabad",
"type": "website",
"data": { "url": "https://example.com/ahmedabad" },
"status": "active",
"safety": "ok",
"scanCount": 0,
"createdAt": 1791504000000
}
}
Put shortUrl into any QR code generator or library — or open the code in the PixQR studio to add your logo and sticker and download print-ready files. Scans of the short link are counted and redirected to your destination.
Optional fields: folder, expiresAt (YYYY-MM-DD), scanLimit, password, data.utm_source, data.utm_medium, data.utm_campaign, and settings:
"settings": {
"access": { "mode": "list", "allow": ["guest@example.com", "@yourcompany.com"], "once": true, "org": "Acme Events" },
"alerts": "daily",
"gps": true,
"startsAt": "2026-12-01T09:00"
}
access.mode is anyone, google (scanners sign in with Google) or list (only the listed emails or @domains). Other types, such as vcard or pdf, can be created by sending type and a data object in the same shape the studio uses.
3. Endpoints
| Method and path | What it does |
|---|---|
GET /me | Your plan, limits and today’s usage |
GET /qr?limit=50&offset=0 | List your QR codes, newest first (up to 100 per page) |
POST /qr | Create a tracked QR code |
GET /qr/{id} | Get one QR code |
PATCH /qr/{id} | Change it — for example {"url": "https://new-link.com"}, {"name": "…"} or {"status": "paused"} |
DELETE /qr/{id} | Delete it. Printed copies stop working. |
GET /qr/{id}/stats?days=30 | Scans per day, unique scanners, devices, operating systems, countries, cities and verified visitors |
4. Limits
Each account has a daily call allowance (1,000 calls a day on the Free plan, reset at midnight India time) and each IP address may send up to 120 requests a minute. Tracked-code limits are the same as in the studio. See plans.
5. Errors
| Status | Meaning |
|---|---|
400 | Invalid input, or the link was refused by the safety checks ("code": "unsafe") — for example a link shortener, a private address or a site Google lists as phishing. |
401 | Missing, wrong or revoked API key |
403 | Plan limit reached ("code": "limit"), the code was disabled by PixQR, or the account is suspended |
404 | The QR code does not exist or is not yours |
428 | Accept the Acceptable Use Policy in the studio once before using the API ("code": "aup") |
429 | Too many requests, or the daily allowance is used up |
Errors return JSON like {"error": "A human-readable message", "code": "limit"}.
6. Safety
Every code is linked to your account, and every create, edit and delete made with a key is recorded in your activity log. Codes that look suspicious are shown to scanners with a warning or held for review ("safety": "warn" or "hold"), and codes that break the Acceptable Use Policy are disabled. Do not use the API to create codes for other people’s content without their permission.
7. Example: Node.js
const res = await fetch('https://pixqr.in/api/v1/qr', {
method: 'POST',
headers: { Authorization: 'Bearer ' + process.env.PIXQR_KEY, 'Content-Type': 'application/json' },
body: JSON.stringify({ name: 'Order 1042 — invoice', url: 'https://example.com/invoice/1042' })
});
const { item, error } = await res.json();
if (!res.ok) throw new Error(error);
console.log(item.shortUrl);
Questions or a higher limit? Write to support@pixqr.in.