API Documentation

QR Codes

QR Codes API

Create, update, and manage dynamic QR codes programmatically. Each QR code can be customized with colors, logos, and tracking capabilities.

Endpoints

Method	Endpoint	Description
POST	/organizations/:orgId/qr-codes	Create a new QR code
GET	/organizations/:orgId/qr-codes	List all QR codes
GET	/organizations/:orgId/qr-codes/:id	Get a specific QR code
PUT	/organizations/:orgId/qr-codes/:id	Update a QR code
DELETE	/organizations/:orgId/qr-codes/:id	Delete a QR code
GET	/organizations/:orgId/qr-codes/:id/download	Download QR code image

Create QR Code

Create a new dynamic QR code with customizable content and styling.

POST

/organizations/:orgId/qr-codes

Request Body

Parameter	Type	Required	Description
type	string	Required	QR code type (URL, VCARD, WIFI, etc.)
name	string	Required	Display name for the QR code
data	object	Required	Content data (varies by type)
style	object	Optional	Visual customization options
folderId	string	Optional	Folder to organize the QR code
tags	string[]	Optional	Tags for categorization

Examples by Type

URL QR Code

curl -X POST \
  https://i-love-qr-production-645dbff8d2fe.herokuapp.com/api/v1/organizations/org_abc123/qr-codes \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "URL",
    "name": "Company Website",
    "data": {
      "url": "https://example.com"
    },
    "style": {
      "foregroundColor": "#000000",
      "backgroundColor": "#FFFFFF",
      "cornerRadius": 10
    }
  }'

Response

{
  "id": "qr_xyz789",
  "type": "URL",
  "name": "Company Website",
  "shortUrl": "https://ilqr.co/xyz789",
  "shortCode": "xyz789",
  "data": {
    "url": "https://example.com"
  },
  "style": {
    "foregroundColor": "#000000",
    "backgroundColor": "#FFFFFF",
    "cornerRadius": 10
  },
  "status": "ACTIVE",
  "totalScans": 0,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

List QR Codes

Retrieve a paginated list of QR codes with optional filtering.

GET

/organizations/:orgId/qr-codes

Query Parameters

Parameter	Type	Description
page	number	Page number (default: 1)
limit	number	Items per page (default: 20, max: 100)
type	string	Filter by QR code type
folderId	string	Filter by folder
search	string	Search by name
status	string	Filter by status (ACTIVE, ARCHIVED)

Update QR Code

Update an existing QR code's content, styling, or metadata. The QR code image remains the same while the destination changes.

PUT

/organizations/:orgId/qr-codes/:id

curl -X PUT \
  https://i-love-qr-production-645dbff8d2fe.herokuapp.com/api/v1/organizations/org_abc123/qr-codes/qr_xyz789 \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Website",
    "data": {
      "url": "https://new-url.example.com"
    }
  }'

Delete QR Code

Permanently delete a QR code. This action cannot be undone. The short URL will stop working.

DELETE

/organizations/:orgId/qr-codes/:id

curl -X DELETE \
  https://i-love-qr-production-645dbff8d2fe.herokuapp.com/api/v1/organizations/org_abc123/qr-codes/qr_xyz789 \
  -H "X-API-Key: YOUR_API_KEY"

Supported QR Code Types

URL

Link to any website or web page

VCARD

Share contact information

WIFI

Connect to WiFi networks

PDF

Link to PDF documents

EMAIL

Pre-filled email composition

SMS

Pre-filled SMS message

PHONE

Direct phone call

TEXT

Plain text content

APP

App store links

VIDEO

Video content links

SOCIAL

Social media links

Next Steps

Learn about related features: