QR Suisse API: REST API documentation
QR Suisse offers a REST API that lets you create, read, update, archive and delete your dynamic QR codes programmatically, search them in your list, download their image (PNG or SVG), and check their scan statistics. It integrates with your existing tools — Zapier, Make, a CRM, an internal script — anywhere an HTTPS request will do.
The API is available with the Pro and Entreprise plans. The Pro plan includes 5 QR code creations via the API per month and 1 API key; the Entreprise plan includes 100 creations per month and up to 10 API keys active at the same time. With either plan, API creation packs can be purchased as an option. Keys are managed from the dashboard. See our pricing for plan and pack details.
Creating a key, choosing its rights, rotating or revoking it: the help page Manage your API keys explains it all, including quotas, freezing on the Free plan and rate limits.
Current version of the API: 1.1.1. What is new in each version and our compatibility commitment are set out in the Version history section of the reference below.
Download the OpenAPI specification
Getting started
- Switch to the Pro or Entreprise plan if you haven't already.
- Generate an API key from your dashboard and choose the rights you need (read, create, update, delete, statistics).
- Authenticate each request with the header Authorization: Bearer <key>.
- See the full endpoint reference below.
Frequently asked questions
Which plans include API access?
What operations does the API support today?
Can I connect the API to an automation tool or an AI agent?
Is there a limit on the number of calls or creations?
What the API does, what the dashboard does
The API and the dashboard work on the same QR codes, but they do not cover the same operations. The table below describes what is available today. The API is reserved for the Pro and Entreprise plans. The dashboard is available on all plans; features reserved for the Pro and Entreprise plans are marked.
| Operation | API | Dashboard |
|---|---|---|
| Create a Link QR code | Yes. For an email, a phone number, a text message or an FTP server, send the full address (mailto:, tel:, sms:, ftp://). | Yes, with assistants: prefilled subject and message, UTM parameters. |
| Create a business card | Yes. | Yes. |
| Create a QR Calendar | Not documented: the API has no event fields (title, times, location) and no dedicated endpoint. Create QR Calendars in the dashboard. | Yes. |
| Change the destination, the label or a business card | Yes. A business card can be updated in part: fields you do not send stay unchanged. | Yes, from the QR code's page. |
| Archive or reactivate | Yes, one QR code at a time, with the active field of the update. Neither archiving nor reactivating counts towards the creation quota. | Yes, one QR code at a time, or up to 100 at once (Pro and Entreprise). |
| Delete permanently | Yes. | Yes, one QR code at a time. |
| List QR codes | Yes, page by page, with search in the label, the destination and the end of the short address, filters (active or archived, type, creation period) and sorting (creation date, label). No filter by creator or by tag, no sorting by number of scans. | Yes, with search, filters (status, type, creator, tags) and sorting. |
| Tags | No. | Yes (Pro and Entreprise). |
| Bulk actions, ZIP download, CSV export | No. Images are downloaded one at a time. | Yes, up to 100 QR codes at once (Pro and Entreprise). |
| Download the image as PNG or SVG | Yes. PNG from 128 to 1024 pixels per side, as you choose. | Yes. |
| Scan statistics | Total and scans per day for one QR code, over 15 months, with no choice of period. | Chart for each QR code, and a Statistics page filterable by QR code and period. History: 7 days on the Free plan, 15 months with Pro and Entreprise. |
| Address with your custom domain | Yes: when your domain is active, the address and image returned by the API use it. | Yes, setup included (Pro and Entreprise). |
| Track this month's API creations | Yes, with GET /usage (QR_CREATE right): creations of the month, monthly quota, credits remaining in your packs and reset date. A refused creation also returns 429 quota_exceeded with the reset date. | Yes, on the API keys screen (“Manager of API keys” permission or Administrator). |
| API keys, members and permissions, subscription, pack purchases | No. | Yes, depending on your plan and permissions. |
- In the dashboard, a QR code's type (Link, Business card or Calendar) is set at creation. Via the API, the destination of a Link or Calendar QR code can be replaced with any accepted address: a Calendar can thus become a Link, and vice versa. A business card remains a business card. Either way, the short address encoded in the image never changes.
- Neither the API nor the dashboard sends automatic notifications (webhooks), for example on a scan or when the quota is reached.
- To resend a creation interrupted by a timeout or a network failure without creating a duplicate, send it with the Idempotency-Key header (one random value per creation, UUID v4 recommended): sent again with the same Idempotency-Key value and the same content within 24 hours, it returns the QR code already created, without creating a second one or using another creation of the quota. Without this header, check the list of your QR codes before sending it again: a successful creation still counts towards the quota, even if you then delete the duplicate QR code.