- Home
- QR code API
QR code API: create, change and track codes from your own systems
A REST API for dynamic QR codes, with signed webhooks for scans and leads.
curl -X PATCH https://qrcodeplanet.com/api/v1/codes/k7q2xb \
-H "Authorization: Bearer qcp_live_…" \
-d '{"destination": "https://harborgrill.example/spring"}'{
"id": "k7q2xb",
"name": "Table tent – spring",
"short_link": "https://qrcodeplanet.com/r/spring",
"destination": "https://harborgrill.example/spring",
"status": "active",
"scans": 0
}Definition
What is a QR code API?
In shortA QR code API lets your own software create QR codes, change where they point and read their scans, without anyone opening the app.
QR Code Planet’s API works on the same dynamic codes you see in My codes. Your website, shop system or script sends a request with an API key, and the code is made or changed straight away. Webhooks send events the other way, so your systems hear about scans and new leads as they happen.
At a glance
- Plan
- Agency
- Style
- REST, JSON over HTTPS, bearer keys
- Limits
- 120 requests a minute per key, up to 10 keys
- Webhooks
- Scans, codes reaching their scan limit, and new leads
- Codes
- Count toward your plan and show in My codes
The problem
Stop copying links between systems
When codes live in one place and your products, events or listings live in another, someone ends up making codes by hand and pasting links back and forth. The API lets the two talk to each other.
| Compared | By hand | With the API |
|---|---|---|
| New product or listing | Someone makes a code and pastes it in | Your system makes the code when the item is added |
| A link changes | Find the code and edit it | One request updates it. The printed code keeps working |
| Scan numbers | Export a CSV and copy it over | Read them from the API, or get each scan as a webhook |
| New leads | Copy them from email into your CRM | Each lead is posted to your server as it comes in |
How it works
Connect your system in three steps
Create a key
In Settings, then API keys. Name it after the system that will use it, and copy it once.
Send requests
Send the key as a bearer token to
https://qrcodeplanet.com/api/v1. Answers come back as JSON.Add a webhook
Optional. Give us an address and we’ll post scans, ended codes and new leads to it.
Endpoints
What you can do with it
Everything works on the dynamic codes in your workspace. The API documentation has every field.
| Method | Path | What it does |
|---|---|---|
| POST | /api/v1/codes | Create a dynamic code. Send a destination, and optionally a name, short link and folder. |
| GET | /api/v1/codes | List codes, filtered by folder or status, a page at a time. |
| GET | /api/v1/codes/{id} | Get one code. |
| PATCH | /api/v1/codes/{id} | Change the destination, name, folder, end date or scan limit. |
| POST | /api/v1/codes/{id}/pause | Pause a code, or resume it. |
| DELETE | /api/v1/codes/{id} | Delete a code and its scan history. |
| GET | /api/v1/codes/{id}/scans | Scans by day, country and device, for up to 365 days. |
| GET | /api/v1/analytics | Scans, unique scans, places and devices for a date range. |
| POST | /api/v1/conversions | Report a sale or sign-up from your own server. |
| POST | /api/v1/static | Get a static code as an SVG image for any text. |
Webhooks
Hear about scans and leads as they happen
Add one address in Settings and we post each event to it as JSON. Every delivery is signed, so you can tell it came from us.
scan.createdSomeone scanned a code. Includes the code id, short link, country, city and device type. No IP addresses, and no bots or link previews.code.endedA code reached its scan limit.lead.createdA new lead from a form with webhook delivery turned on, with the answers and the code and campaign it came from.
https://hooks.harborgrill.co/qr-eventsSaveRemovex-qcp-signature header: the HMAC-SHA256 of the body, signed with this secret.Each delivery has an x-qcp-signature header: the HMAC-SHA256 of the body, signed with your webhook’s secret.
Use cases
What people build with it
- Product labelsA code for each new product, made when it’s added to your catalog.
- Property listingsA code per listing that points to the next property when one sells.
- EventsA code per session or stand, updated when the schedule changes.
- Print workflowsCodes made and named by the script that prepares your print files.
- ReportingScan counts pulled into your own dashboard or spreadsheet every day.
- CRMLeads from your forms posted straight to your CRM with the code they came from.
Plans
What each plan includes
| Feature | Free | Lite | Pro | Agency |
|---|---|---|---|---|
| API keys and REST API | Not included | Not included | Not included | Included |
| Webhooks | Not included | Not included | Not included | Included |
| Dynamic codes | 3 | 25 | 250 | 2,000 |
| Bulk creation from a CSV | Not included | Included | Included | Included |
Not on Agency? Bulk creation makes hundreds of codes from a spreadsheet on every paid plan.
Good to know
Before you connect
- 120 requests a minutePer key, for every endpoint. Use more than one key for separate systems.
- Keys are shown onceWe keep only a fingerprint of each key. Lost one? Revoke it and make a new one.
- Destinations are checkedNew links are checked against known unsafe sites before a code is made or changed.
- Changes are recordedDestination changes show in the code’s Link history, with the name of the key that made them.
- Short links stay putA code’s short link can’t change once it’s made, so printed codes keep working.
- Webhooks aren’t retriedEach event is sent once. Read scan counts from the API if you need every one.
FAQ
Questions people ask
Can’t find yours? A person answers every email within 2 working days.
Email usWhich plan includes the API?
Agency. API keys, the REST API and webhooks are all part of the Agency plan.
Is there a rate limit?
Yes: 120 requests a minute per key, for every endpoint. Past that, you get a 429 response with the code "rate". You can have up to 10 keys.
What kinds of codes can the API create?
Dynamic link codes, which you can change, pause and track later. For any other content, such as Wi-Fi details or a vCard, send the text to the static endpoint and you get the QR code back as an SVG image.
Do codes made through the API count toward my plan?
Yes. Dynamic codes made through the API count toward your plan’s dynamic codes, the same as codes made in the app, and they appear in My codes.
Who can create API keys?
The workspace owner and admins, in Settings, then API keys. Each key is shown once when it’s made, so copy it somewhere safe.
What if a key leaks?
Revoke it in Settings, then API keys. It stops working straight away, and your other keys keep working.
Are webhook deliveries retried?
No. Each event is sent once, with a 5-second timeout. If you need every scan, read the scan counts from the API as well.
Where’s the full reference?
The API documentation lists every endpoint with its fields. It’s at qrcodeplanet.com/api-docs.
Connect QR Code Planet to your systems
Create a key, send your first request and add a webhook.
Free QR codes. No watermark. No expiry.
Keep reading


