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

  1. Switch to the Pro or Entreprise plan if you haven't already.
  2. Generate an API key from your dashboard and choose the rights you need (read, create, update, delete, statistics).
  3. Authenticate each request with the header Authorization: Bearer <key>.
  4. See the full endpoint reference below.

Frequently asked questions

Which plans include API access?
The Pro and Entreprise plans, at no extra cost. 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. The Free plan does not include API access.
What operations does the API support today?
Creating, reading, updating, archiving (and reactivating) and deleting QR codes (URL and business card types), searching, filtering and sorting their list, downloading their image (PNG or SVG), reading their scan statistics and reading the remaining creation quota. A creation interrupted by a network failure can be sent again without a duplicate, using the Idempotency-Key header. Managing existing QR codes (reading, updating, archiving, deleting, downloading the image, statistics) is not subject to the quota.
Can I connect the API to an automation tool or an AI agent?
The API is a standard, key-authenticated REST API — it can be called from any tool capable of sending HTTPS requests, including Zapier or Make, or from an agent that queries these endpoints directly. A dedicated AI assistant connector (MCP) is not available at this time.
Is there a limit on the number of calls or creations?
Yes, two. A rate limit protects the service: 30 requests per minute per key, including at most 8 creations, and 10 PNG images per minute for the whole account; beyond that, the API responds with 429 rate_limited and the time to wait. In addition, only QR code creation via the API is subject to a monthly quota: 5 creations per calendar month with the Pro plan, 100 with the Entreprise plan, not carried over from one month to the next. If that quota is not enough, API creation packs (one-time purchase, non-refundable, active Pro or Entreprise subscription required) are added on top. Reading, updating, archiving, deleting, downloading images and reading statistics do not use this quota. Your tool can read the creations of the month and the remaining balance at any time with GET /usage.

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.

Operations available via the API and in the dashboard
OperationAPIDashboard
Create a Link QR codeYes. 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 cardYes.Yes.
Create a QR CalendarNot 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 cardYes. A business card can be updated in part: fields you do not send stay unchanged.Yes, from the QR code's page.
Archive or reactivateYes, 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 permanentlyYes.Yes, one QR code at a time.
List QR codesYes, 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.
TagsNo.Yes (Pro and Entreprise).
Bulk actions, ZIP download, CSV exportNo. Images are downloaded one at a time.Yes, up to 100 QR codes at once (Pro and Entreprise).
Download the image as PNG or SVGYes. PNG from 128 to 1024 pixels per side, as you choose.Yes.
Scan statisticsTotal 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 domainYes: 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 creationsYes, 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 purchasesNo.Yes, depending on your plan and permissions.

Endpoint reference