Skip to main content

Quick Start

Create your first QR code using the API in under 5 minutes.

Prerequisites​

  • A QR Build account with an active subscription
  • An API key (see Authentication)

Step 1: Create a Simple URL QR Code​

Create a QR code that links to a website. Send a POST request to /qr-codes with a name, type, and content object.

The response includes the QR code ID and a short_url that redirects to your destination.

Create a QR Code​

curl -X POST "https://integration-api.qr-build.com/qr-codes" \
  -H "X-API-Key: qrb_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Website QR",
    "type": "url",
    "content": {
      "type": "url",
      "url": "https://example.com"
    }
  }'
{
  "object": "qr",
  "success": true,
  "data": {
    "id": "qr-aBc123XyZ9",
    "name": "My Website QR",
    "type": "url",
    "content": {
      "url": "https://example.com"
    },
    "design": {
      "dots": { "style": "rounded", "color": "#000000" },
      "corners": { "style": "extra-rounded", "color": "#000000" },
      "corners_dot": { "style": "dot", "color": "#000000" },
      "background": { "color": "#ffffff" },
      "logo_url": null,
      "margin": 10
    },
    "active": true,
    "short_url": "https://qr-build.io/qr-aBc123XyZ9",
    "created_at": "2026-02-16T10:30:00Z",
    "updated_at": "2026-02-16T10:30:00Z"
  }
}

Step 2: Add Custom Design​

Add colors and styling to your QR code by including a design object. You can customize dots, corners, background, and add a logo.

See Design Customization for all available options, or try the Design Builder to experiment visually.

Create with Custom Design​

curl -X POST "https://integration-api.qr-build.com/qr-codes" \
  -H "X-API-Key: qrb_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Styled QR Code",
    "type": "url",
    "content": {
      "type": "url",
      "url": "https://example.com"
    },
    "design": {
      "dots": { "style": "rounded", "color": "#6366f1" },
      "corners": { "style": "extra-rounded", "color": "#4f46e5" },
      "background": { "color": "#ffffff" }
    }
  }'

Step 3: List Your QR Codes​

Retrieve all QR codes in your workspace with pagination.

List QR Codes​

curl -X GET "https://integration-api.qr-build.com/qr-codes" \
  -H "X-API-Key: qrb_live_your_api_key_here"
{
  "object": "list",
  "success": true,
  "data": [
    {
      "id": "qr-aBc123XyZ9",
      "name": "My Website QR",
      "type": "url",
      "active": true,
      "created_at": "2026-02-16T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "has_more": false
  }
}

Step 4: Update a QR Code​

Change the destination URL without creating a new QR code. The short URL and printed QR code stay the same.

Next Steps​

Update Destination​

curl -X PATCH "https://integration-api.qr-build.com/qr-codes/qr-aBc123XyZ9" \
  -H "X-API-Key: qrb_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": {
      "type": "url",
      "url": "https://new-destination.com"
    }
  }'