API Documentation

Build with the EZQR API

Generate, manage, and track QR codes programmatically. Available on the Business plan ($20/mo).

Interactive Swagger UI OpenAPI Spec (JSON)

Authentication

Include your API key in the Authorization header:

curl -H "Authorization: Bearer ezqr_your_api_key" \
  https://ez-qr.com/api/v1/qr-codes

Generate API keys from your dashboard settings.

Create a QR Code

curl -X POST https://ez-qr.com/api/v1/qr-codes \
  -H "Authorization: Bearer ezqr_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My QR Code",
    "type": "dynamic",
    "contentType": "url",
    "content": "https://example.com",
    "targetUrl": "https://example.com"
  }'

Endpoints

Method	Endpoint	Description
GET	/api/v1/qr-codes	List your QR codes
POST	/api/v1/qr-codes	Create a QR code
GET	/api/v1/qr-codes/:id	Get a QR code
PATCH	/api/v1/qr-codes/:id	Update a QR code
DELETE	/api/v1/qr-codes/:id	Delete a QR code
GET	/api/v1/qr-codes/:id/analytics	Get scan analytics
POST	/api/v1/qr-codes/batch	Bulk create QR codes (max 100)
GET	/api/v1/showcases	List landing pages
POST	/api/v1/showcases	Create a landing page

Rate Limits

100 requests per minute per API key. Rate limit headers are included in every response:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: requests left