API reference
API reference
All 22 endpoints of the QRBold REST API. Each one lists its parameters, an example request in three languages, the response, and the errors it can return.
Conventions
https://api.qrbold.com/api/public/v1| Topic | Rule |
|---|---|
| Authentication | Authorization: Bearer YOUR_API_KEY on every request. Details. |
| Requests | JSON bodies with Content-Type: application/json. |
| Responses | JSON with an object field naming the type. The image endpoint returns a file. Deletes return 204 with no body. |
| Lists | { object: "list", data: [], pagination: { total, limit, offset, hasMore } }. Pagination. |
| Errors | { error: { type, code, message, details? } }. Error reference. |
| Rate limit | Per key, per minute. Rate limits. |
| Safe retries | Optional Idempotency-Key header on writes. Idempotency. |
| Plan | The Pro plan, or the Business card plan, for every endpoint. |
All endpoints
Account
Check that a key works and see what it is allowed to do.
| Endpoint | What it does | Scope |
|---|---|---|
GET/me | Check a key | None |
Digital business cards
Create, read, update and delete digital business cards.
| Endpoint | What it does | Scope |
|---|---|---|
POST/cards | Create a card | cards:write |
GET/cards | List cards | cards:read |
GET/cards/:id | Retrieve a card | cards:read |
PATCH/cards/:id | Update a card | cards:write |
DELETE/cards/:id | Delete a card | cards:write |
GET/cards/:id/wallet | Get wallet links | cards:read |
Card templates
Read the templates a card can be created from, and the field rules each one imposes.
| Endpoint | What it does | Scope |
|---|---|---|
GET/templates | List templates | templates:read |
GET/templates/:id | Retrieve a template | templates:read |
QR codes
Create and manage dynamic QR codes that redirect to a URL, and list every other code in the account.
| Endpoint | What it does | Scope |
|---|---|---|
POST/qr-codes | Create a QR code | qr:write |
GET/qr-codes | List QR codes | qr:read |
GET/qr-codes/:id | Retrieve a QR code | qr:read |
PATCH/qr-codes/:id | Update a QR code | qr:write |
DELETE/qr-codes/:id | Delete a QR code | qr:write |
QR images
Download the QR image for a QR code or a digital business card.
| Endpoint | What it does | Scope |
|---|---|---|
GET/qr-codes/:id/image | Download a QR image | qr:read or cards:read |
Analytics
Read scan totals, a daily timeline and, on plans that include them, country and device breakdowns.
| Endpoint | What it does | Scope |
|---|---|---|
GET/analytics/overview | Account scan statistics | analytics:read |
GET/analytics/:id | Scan statistics for one code or card | analytics:read |
Campaign ingestion
Create one card per request from your own JSON shape, using a template and mapping configured once in the dashboard.
| Endpoint | What it does | Scope |
|---|---|---|
GET/campaigns | List campaigns | cards:read |
GET/campaigns/:campaignId | Retrieve a campaign | cards:read |
GET/campaigns/:campaignId/schema | Get a campaign’s payload schema | cards:read |
POST/campaigns/:campaignId/cards/test | Dry-run a campaign card | cards:write |
POST/campaigns/:campaignId/cards | Create a card in a campaign | cards:write |
Looking for something that is not listed? It is probably on What the API does not do.
OpenAPI and Postman
Both files are generated from the same endpoint definitions as these pages, so they describe the same 22 endpoints and nothing else.
- Postman: choose Import, select the file, then set the collection variable
apiKeyto your key. Every request inherits it. Keep the key in a Postman vault or an environment that you do not share. - OpenAPI: import it into any tool that reads OpenAPI 3.1, such as an API client or a code generator. QRBold does not publish official SDKs; a generated client is your own code to maintain.
- Neither file contains a key. Both point at the live API, because there is no sandbox.
To try a request without installing anything, use the API explorer.