CLI and API · Autessa QR Codes
QR code API and CLI
Autessa QR Codes has a full QR code API and CLI: you can create codes, change destinations, pause, restyle, tag, share, delete and read scan stats with commands like autessa qr-codes create and autessa qr-codes stats. There are no web-only steps.
The problem
Codes at scale should not mean clicking at scale
A code per store, per event session or per product line quickly becomes dozens of codes. Making each one by hand, and later changing each destination by hand, is slow and error-prone. A QR code API lets you script the whole lifecycle and pull scan numbers into your own reports.
FROM THE PRINT SHOP
Generate one code per location from a list with a short script, then call stats weekly to see which locations get scanned the most.
What you get
- create: name, destination, active flag, design and UTM tags in one call; returns the slug and the public scan URL.
- list: every code you can access, owned and shared.
- get: one code’s destination, design, UTM tags, slug and public scan URL.
- update: change the name, destination, active state, design or UTM tags.
- delete: permanently delete a code.
- set-share-level, share, shares and unshare: control who can see and edit a code.
- stats: totals, daily scans, scans by hour of day and recent scans.
- The same permissions apply as in the web app.
How it works
How does qR code API and CLI work?
Install and sign in
Install the Autessa CLI and sign in to your company.
Create a code
autessa qr-codes create --name "Booth poster" --destinationUrl "https://example.com/booth".
Manage it
Use update to repoint or pause, and share to grant teammates access.
Read stats
autessa qr-codes stats returns JSON you can drop into a report.
Every option
Commands in autessa qr-codes
| Option | What it does |
|---|---|
| create | Build a new QR code pointing at a destination URL. Optional design and utm objects. |
| list | List every QR code you can access in the current company. |
| get | Fetch one code by id, including its destination, design, UTM tags, slug and public scan URL. |
| update | Update a code’s name, destination, active state, design or UTM tags. |
| delete | Permanently delete a code. |
| set-share-level | PRIVATE (owner and explicitly shared members) or COMPANY (everyone in the company can see it). |
| share / unshare | Grant or revoke a member’s access at a given level. |
| shares | List the members a code is shared with and their levels. |
| stats | Totals and breakdowns of when, from what device and from where a code was scanned. |
Permissions
Who can do what?
QR codes are private by default. Access comes from ownership, the company admin role, or a share at a chosen level.
| Who | Can |
|---|---|
| Any member with QR Codes | Run every command, limited to the codes they can access and the level they hold on each. |
Try it on your phone
This is a real code, drawn with the same encoder Autessa QR Codes uses. Point your camera at it and it opens the QR Codes overview.
FAQ
Questions about qR code API and CLI
Is there an API for creating QR codes?
Yes. Every QR code action in Autessa is available in the Autessa CLI and API, from create and update to share and stats.
Can I change a QR code’s destination from the command line?
Yes. autessa qr-codes update with a new destinationUrl repoints the code immediately.
Can I export scan data?
Yes. autessa qr-codes stats returns totals, daily counts, hour-of-day counts and recent scans as JSON.
Where is the reference?
Run autessa qr-codes help, or read the QR Codes page in the Autessa CLI docs at docs.autessa.com.
100% customizable, code and all
Make Autessa QR Codes fully your own.
Use it out of the box, then change anything. Ask Autobot, Autessa’s AI builder, for a new field, screen, report, workflow or agent and it builds it into your copy of the app. Or open the code and edit it yourself. Nothing is locked: the app, its data and its code are yours.
Start free and make it yours