API Reference
Complete reference for all QR Build API endpoints.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /qr-codes | Create a new QR code |
| GET | /qr-codes | List all QR codes |
| GET | /qr-codes/:id | Get a specific QR code |
| PATCH | /qr-codes/:id | Update a QR code |
| DELETE | /qr-codes/:id | Delete a QR code |
| GET | /qr-codes/:id/image | Generate QR code image |
| GET | /folders | List all folders |
| POST | /folders | Create a folder |
| PATCH | /folders/:id | Update a folder |
| DELETE | /folders/:id | Delete a folder |
| GET | /templates | List all templates |
| GET | /templates/:id | Get a template |
| POST | /templates | Create a template |
| PATCH | /templates/:id | Update a template |
| DELETE | /templates/:id | Delete a template |
Supported QR Types
| Type | Description | Docs |
|---|---|---|
url | Link to any website URL | URL |
vCard | Digital business card | vCard |
wifi | WiFi network credentials | WiFi |
email | Pre-filled email | |
pdf | PDF document | |
socialMedia | Social media links | Social Media |
linkList | Multiple links (link-in-bio) | Link List |
location | Google Maps location | Location |
event | Calendar event | Event |
app | App store links | App |
video | Video gallery | Video |
images | Image gallery | Images |
coupon | Discount coupon | Coupon |
businessPage | Business landing page | Business Page |
plainText | Plain text content | Plain Text |
Quick Reference
Base URL: https://integration-api.qr-build.com
Auth: X-API-Key header
Versioning: QR-Version header (date-based)
Rate limits: Per workspace, monthly
Authentication
curl -X GET "https://integration-api.qr-build.com/qr-codes" \
-H "X-API-Key: qrb_live_your_api_key_here" \
-H "QR-Version: 2026-02-16"
Response Format
{
"object": "qr",
"success": true,
"data": { ... }
}
Error Format
{
"success": false,
"error": {
"code": "ERROR_CODE",
"message": "Description"
}
}
Useful Links
- Authentication
- Rate Limits
- Error Codes
- Design Customization
- Design Builder — interactive playground