API reference
Every endpoint, generated from the same description your tools can use.
The base address is https://pikaqr.com/api/v1. Send your key as Authorization: Bearer <key>. The full description is at /api/v1/openapi.json.
Codes
Dynamic QR codes and where they go.
/qrList your codes
limit How many to return, up to 100
offset How many to skip
q Search by title
tag Only codes with this tag
/qrCreate a code
A url or menu code takes destination_url. Text, phone, sms and email codes take content, and an sms code can also take sms_body. A menu is a link to your menu that can have tables.
/qr/{id}Get a code
/qr/{id}Update a code
Send only what changes. Changing the destination keeps the old one in the code’s history.
/qr/{id}Delete a code
/qr/{id}/imageGet a code as an image
The image always encodes the code’s own short link.
format The file type
size Width in pixels, from 64 to 2048
Tables
Tables on a menu code, each with its own printed code. A table follows its menu’s destination, rules and password, and its scans count toward the menu. On Free, a menu can have 5 tables, and each table counts as one of the 25 codes.
/qr/{id}/tablesList a menu’s tables
/qr/{id}/tablesAdd tables
Send a name for one table, or a name with from and to for a numbered run: {"name": "Table", "from": 1, "to": 12} adds Table 1 to Table 12. Up to 100 at a time.
/qr/{id}/tables/{tableId}Get a table
/qr/{id}/tables/{tableId}Update a table
Rename it, or pause it with is_active false. A paused table’s code shows a not-found page; its menu and the other tables keep working.
/qr/{id}/tables/{tableId}Delete a table
Its printed code stops working, and its scans are deleted and come off the menu’s total. To keep them, pause it instead.
/qr/{id}/tables/{tableId}/imageGet a table’s code as an image
Drawn in the menu’s colors. It encodes the table’s own short link.
format The file type
size Width in pixels, from 64 to 2048
Rules
Send scans to different places. Writing rules needs Premium.
/qr/{id}/rulesList a code’s rules
/qr/{id}/rulesReplace a code’s rules
Send the full list in order. Include a rule’s id to keep its history. Works on url and menu codes, and a menu’s rules apply to its tables.
Scans
What happened when codes were scanned.
/qr/{id}/scansList a code’s scans
A menu’s scans include its tables’. Each scan says which table it came from.
limit How many to return, up to 200
offset How many to skip
table_id Only scans of this table
/qr/{id}/analyticsGet scan totals
days How far back, up to 365
Webhooks
Get every scan sent to your own software. Adding a webhook needs Premium.
/webhooksList your webhooks
/webhooksAdd a webhook
The reply includes the signing secret, once. Addresses must use https and be reachable from the internet.
/webhooks/{id}Get a webhook
/webhooks/{id}Update a webhook
/webhooks/{id}Delete a webhook
/webhooks/{id}/testSend a test event
/webhooks/{id}/deliveries