API Documentation (v1)

Retrieve a list of all QR codes associated with your account.

Example Request:

curl -X GET "https://api.qrflow.in/v1/qrcodes" \
     -H "Authorization: Bearer YOUR_API_KEY"

Success Response:

{
  "data": [
    {
      "id": 124,
      "name": "Spring Sale 2024",
      "short_code": "a1b2c3d",
      "destination_url": "https://example.com/sale",
      "status": "active",
      "created_at": "2024-03-21 14:30:00",
      "redirect_url": "https://qrflow.in/r/a1b2c3d"
    }
  ],
  "count": 1
}

Create a new dynamic QR code.

Request Body:

Example Request:

curl -X POST "https://api.qrflow.in/v1/qrcodes" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "New Campaign",
       "destination_url": "https://myproduct.com"
     }'

Fetch details for a specific QR code by its ID.

Directly fetch the QR code image file. This endpoint is public and does not require an Authorization header, making it ideal for embedding images directly in your application.

Update the destination or status of an existing QR code.

Payload options:

• name (string)
• destination_url (url)
• status ("active" or "paused")

Permanently delete a QR code. Warning: This cannot be undone.

Retrieve detailed scan analytics for a specific QR code, including total scans, unique visitors, and recent scan logs.

Query Parameters:

• limit (int, default: 100, max: 1000) - Number of recent scans to return.

Example Response:

{
  "data": {
    "qr_id": "124",
    "summary": {
      "total_scans": 450,
      "unique_scans": 380
    },
    "recent_scans": [
      {
        "city": "New York",
        "device_type": "mobile",
        "scanned_at": "2024-03-22 10:15:22"
      }
    ]
  }
}