---
title: "QR Code Templates API Reference | Linkbreakers"
description: "Reusable QR code designs: save one, publish it, import a public one, and apply it to links."
canonical: "https://linkbreakers.com/help/api/qr-code-templates"
---

# QR Code Templates

Reusable QR code designs: save one, publish it, import a public one, and apply it to links.

10 entries on this page

## The qr code template object

Reusable QR code design presets that help teams create branded links with consistent styling and messaging.

`builtIn` boolean

Whether the template is maintained by Linkbreakers (available to every workspace)

`createdAt` string (date-time)

When the template was created

`description` string

Short marketing description displayed in the template picker

`duplicatedFrom` string

Reference to the original public template when this template was created via import. Null for original templates.

`faq` string

FAQ data stored as JSON.

Frequently Asked Questions about this template stored as JSON

`id` string

Unique identifier of the template (UUID)

`learnMore` string

Extended markdown-supported content providing detailed information about the template

`name` string

Human-readable name shown in the gallery

`owned` boolean

True when the template belongs to the caller's workspace. False for built-in templates and for community templates published by other workspaces.

`publishedAt` string (date-time)

When the template was published. Null means private template, only visible to creating workspace.

`qrcodeDesign` object

How a QR code looks: colors, shapes, export options and center image.

A design is attached to one record at a time: a link, or a QR code template that makes it reusable.

18 child attributes

`backgroundOptions` object

The styling options for the background

1 child attribute

`themeColor` object

Color configuration supporting solid colors and gradients

4 child attributes

`colors` array of string 

Required

Color values in render order (hex, rgb/rgba, hsl/hsla).

`direction` string

Optional direction for linear gradients (e.g. "135deg", "to right").

`stops` array of string

Optional stop offsets aligned with `colors` (e.g. "0%", "50%", "100%").

`type` enum 

Required

Color type

Allowed values

* `THEME_COLOR_TYPE_SOLID`
* `THEME_COLOR_TYPE_LINEAR`
* `THEME_COLOR_TYPE_RADIAL`

`centralImageMargin` integer (int32)

The margin around the central image in pixels

`centralImageMediaId` string 

Read-only

The media library item the central image (the QR code logo) was picked from (UUID). Empty when the logo came from a template or a public upload, or there is none. The design keeps its own copy of the image, so the logo survives the media being deleted; this id may then name media that no longer exists.

`centralImageSignedUrl` string 

Read-only

The signed URL for the central image This URL eventually expires

`centralImageSize` number (double)

The size of the central image relative to the QR code (0.0-1.0 proportion)

`cornersDotOptions` object

The styling options for the dot corners

2 child attributes

`themeColor` object

Color configuration supporting solid colors and gradients

4 child attributes

`colors` array of string 

Required

Color values in render order (hex, rgb/rgba, hsl/hsla).

`direction` string

Optional direction for linear gradients (e.g. "135deg", "to right").

`stops` array of string

Optional stop offsets aligned with `colors` (e.g. "0%", "50%", "100%").

`type` enum 

Required

Color type

Allowed values

* `THEME_COLOR_TYPE_SOLID`
* `THEME_COLOR_TYPE_LINEAR`
* `THEME_COLOR_TYPE_RADIAL`

`type` enum

Rendering style for the dot corners

Allowed values

* `CORNERS_DOT_TYPE_DOT`
* `CORNERS_DOT_TYPE_SQUARE`
* `CORNERS_DOT_TYPE_HEXAGON`
* `CORNERS_DOT_TYPE_OCTAGON`
* `CORNERS_DOT_TYPE_TEARDROP`
* `CORNERS_DOT_TYPE_STAR`

`cornersSquareOptions` object

The styling options for the square corners

2 child attributes

`themeColor` object

Color configuration supporting solid colors and gradients

4 child attributes

`colors` array of string 

Required

Color values in render order (hex, rgb/rgba, hsl/hsla).

`direction` string

Optional direction for linear gradients (e.g. "135deg", "to right").

`stops` array of string

Optional stop offsets aligned with `colors` (e.g. "0%", "50%", "100%").

`type` enum 

Required

Color type

Allowed values

* `THEME_COLOR_TYPE_SOLID`
* `THEME_COLOR_TYPE_LINEAR`
* `THEME_COLOR_TYPE_RADIAL`

`type` enum

Rendering style for the square corners

Allowed values

* `CORNERS_SQUARE_TYPE_DOT`
* `CORNERS_SQUARE_TYPE_SQUARE`
* `CORNERS_SQUARE_TYPE_EXTRA_ROUNDED`
* `CORNERS_SQUARE_TYPE_HEXAGON`
* `CORNERS_SQUARE_TYPE_OCTAGON`
* `CORNERS_SQUARE_TYPE_LEAF`

`createdAt` string (date-time) 

Read-only

When the QR code design was created

`dotsOptions` object

The styling options for the dots

2 child attributes

`themeColor` object

Color configuration supporting solid colors and gradients

4 child attributes

`colors` array of string 

Required

Color values in render order (hex, rgb/rgba, hsl/hsla).

`direction` string

Optional direction for linear gradients (e.g. "135deg", "to right").

`stops` array of string

Optional stop offsets aligned with `colors` (e.g. "0%", "50%", "100%").

`type` enum 

Required

Color type

Allowed values

* `THEME_COLOR_TYPE_SOLID`
* `THEME_COLOR_TYPE_LINEAR`
* `THEME_COLOR_TYPE_RADIAL`

`type` enum

Rendering style for data dots

Allowed values

* `DOTS_TYPE_SQUARE`
* `DOTS_TYPE_DOTS`
* `DOTS_TYPE_BUBBLY_DOTS`
* `DOTS_TYPE_CIRCUIT_CHIP`
* `DOTS_TYPE_ROUNDED`
* `DOTS_TYPE_EXTRA_ROUNDED`
* `DOTS_TYPE_CLASSY`
* `DOTS_TYPE_CLASSY_ROUNDED`
* `DOTS_TYPE_HEXAGON`
* `DOTS_TYPE_OCTAGON`

`errorCorrectionLevel` string

Error correction level forwarded to the QR renderer ("L","M","Q","H")

`hasCentralImage` boolean 

Read-only

Whether the design has a central image (a logo) right now, however it got there: applied from a template, uploaded, or picked from the media library. An update that leaves the central image fields out keeps it.

`height` integer (int32)

Export height in pixels

`hideBackgroundDots` boolean

Whether to remove dots behind the central image to improve contrast

`id` string

The unique identifier of the QR code design (UUID)

`outputFileFormat` enum

The output file format for the QR code.

Allowed values

* `OUTPUT_FILE_FORMAT_SVG` Scalable Vector Graphics format for infinite resolution
* `OUTPUT_FILE_FORMAT_PNG` Portable Network Graphics format with transparency support
* `OUTPUT_FILE_FORMAT_JPEG` Joint Photographic Experts Group format for compressed images
* `OUTPUT_FILE_FORMAT_WEBP` WebP format for modern web-optimized compression
* `OUTPUT_FILE_FORMAT_UNSPECIFIED` Output format not specified (defaults to PNG server-side)

`shape` enum

The shape of the QR code.

Allowed values

* `SHAPE_SQUARE` Traditional square modules for QR code data points
* `SHAPE_CIRCLE` Circular modules for a rounded visual appearance
* `SHAPE_UNSPECIFIED` Shape not specified (defaults to square modules)

`updatedAt` string (date-time) 

Read-only

When the QR code design was last updated

`width` integer (int32)

Export width in pixels

`qrcodeDesignId` string

Backing QR code design that determines styling defaults (UUID)

`slug` string

Slug used in public template selection URLs

`tags` string

Tags for categorizing and filtering templates (comma-separated)

`thumbnailPendingUpdateSince` string (date-time)

When the template thumbnail entered the regeneration queue

`thumbnailSignedUrl` string

Signed thumbnail preview of the template design

`updatedAt` string (date-time)

When the template metadata was last updated

`usageCount` integer (int64)

Number of links in the caller's workspace that were created from this template. Drives the 'most used' ordering in the template picker.

`workspaceId` string

Workspace that owns the template; empty for built-in templates (UUID when present)

Example qr code template

```json
{
  "builtIn": false,
  "createdAt": "2026-03-14T09:30:00Z",
  "description": "Rounded navy dots on a cream background, with room for your logo in the centre.",
  "duplicatedFrom": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
  "faq": "{\"items\": [{\"id\": \"1\", \"question\": \"Can I put my own logo in the middle?\", \"answer\": \"Yes, upload it on the design and the dots behind it are hidden.\", \"order\": 1}]}",
  "id": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
  "learnMore": "## When to use it\nTable cards and menus where the QR code should match a warm, classic decor.",
  "name": "Bistro Navy",
  "owned": true,
  "publishedAt": "2026-03-18T16:05:00Z",
  "qrcodeDesign": {
    "backgroundOptions": {
      "themeColor": {
        "colors": [
          "#1F3A5F",
          "#F4EDE4"
        ],
        "direction": "135deg",
        "stops": [
          "0%",
          "100%"
        ],
        "type": "THEME_COLOR_TYPE_LINEAR"
      }
    },
    "centralImageMargin": 8,
    "centralImageMediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f",
    "centralImageSignedUrl": "https://cdn.linkbreakers.com/media/5f1c2d3e/menu-cover.png",
    "centralImageSize": 0.3,
    "cornersDotOptions": {
      "themeColor": {
        "colors": [
          "#1F3A5F",
          "#F4EDE4"
        ],
        "direction": "135deg",
        "stops": [
          "0%",
          "100%"
        ],
        "type": "THEME_COLOR_TYPE_LINEAR"
      },
      "type": "CORNERS_DOT_TYPE_DOT"
    },
    "cornersSquareOptions": {
      "themeColor": {
        "colors": [
          "#1F3A5F",
          "#F4EDE4"
        ],
        "direction": "135deg",
        "stops": [
          "0%",
          "100%"
        ],
        "type": "THEME_COLOR_TYPE_LINEAR"
      },
      "type": "CORNERS_SQUARE_TYPE_EXTRA_ROUNDED"
    },
    "createdAt": "2026-03-14T09:30:00Z",
    "dotsOptions": {
      "themeColor": {
        "colors": [
          "#1F3A5F",
          "#F4EDE4"
        ],
        "direction": "135deg",
        "stops": [
          "0%",
          "100%"
        ],
        "type": "THEME_COLOR_TYPE_LINEAR"
      },
      "type": "DOTS_TYPE_ROUNDED"
    },
    "errorCorrectionLevel": "H",
    "hasCentralImage": true,
    "height": 1024,
    "hideBackgroundDots": true,
    "id": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
    "outputFileFormat": "OUTPUT_FILE_FORMAT_PNG",
    "shape": "SHAPE_SQUARE",
    "updatedAt": "2026-03-18T16:05:00Z",
    "width": 1024
  },
  "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
  "slug": "bistro-navy",
  "tags": "restaurant,menu,elegant",
  "thumbnailPendingUpdateSince": "2026-03-18T16:05:00Z",
  "thumbnailSignedUrl": "https://cdn.linkbreakers.com/qrcode-templates/0d7f4d9c/thumbnail.png",
  "updatedAt": "2026-03-18T16:05:00Z",
  "usageCount": 12,
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}
```

### Parameters

`include` array of string 

query

Related objects to include in the response

List of related objects to include. Supported values: 'workspace'

`search` string 

query

Search query applied to template name/description

`pageSize` integer (int64) 

query

Maximum number of templates to return (defaults to 20)

`pageToken` string 

query

Cursor token to retrieve the next page of results

`workspaceId` string 

query

Optional workspace ID to filter templates by workspace

Filter public templates by workspace. Only published templates for that workspace will be returned.

`cursor` string 

query

Opaque cursor from the previous page's nextPageToken. Same as pageToken; when both are sent, pageToken wins.

### Response

200

`hasMore` boolean

Whether another page exists after this result set

`nextPageToken` string

Cursor token for the next page, if any.

Cursor token returned when another page is available

`qrcodeTemplates` array of object

10 child attributes

`builtIn` boolean

Whether the template is maintained by Linkbreakers (available to every workspace)

`description` string

Short marketing description displayed in the template picker

`faq` string

FAQ data stored as JSON.

Frequently Asked Questions about this template stored as JSON

`learnMore` string

Extended markdown-supported content providing detailed information about the template

`name` string

Human-readable name shown in the gallery

`publishedAt` string (date-time)

When the template was published and made available to all workspaces

`slug` string

Slug used in public template selection URLs

`tags` string

Tags for categorizing and filtering templates (comma-separated)

`thumbnailSignedUrl` string

Signed thumbnail preview of the template design

`workspace` object

Public information about the workspace that created this template. Empty for built-in templates. Only included when 'workspace' is specified in the include parameter.

8 child attributes

`description` string

Optional description providing additional context about the workspace

`faq` string

FAQ data stored as JSON.

Frequently Asked Questions about this workspace stored as JSON

`name` string

Human-readable display name

`publishedAt` string (date-time)

Timestamp when the workspace was published/made public

`shortDescription` string

Short description for the workspace

`slug` string

Unique slug for the workspace (URL-friendly identifier)

`tags` string

Comma-separated tags for the workspace

`website` string

Website URL for the workspace

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/public/qrcode-templates"
```

Response 200

```json
{
  "hasMore": true,
  "nextPageToken": "eyJxdHMiOiJxdGVtcGxhdGUifQ==",
  "qrcodeTemplates": [
    {
      "builtIn": false,
      "description": "Rounded navy dots on a cream background, with room for your logo in the centre.",
      "faq": "{\"items\": [{\"id\": \"1\", \"question\": \"Can I put my own logo in the middle?\", \"answer\": \"Yes, upload it on the design and the dots behind it are hidden.\", \"order\": 1}]}",
      "learnMore": "## When to use it\nTable cards and menus where the QR code should match a warm, classic decor.",
      "name": "Bistro Navy",
      "publishedAt": "2026-03-18T16:05:00Z",
      "slug": "bistro-navy",
      "tags": "restaurant,menu,elegant",
      "thumbnailSignedUrl": "https://cdn.linkbreakers.com/qrcode-templates/0d7f4d9c/thumbnail.png",
      "workspace": {
        "description": "Boutique hotel in Lyon with a restaurant and a rooftop bar. Our QR codes sit on restaurant tables, flyers and posters.",
        "faq": "[{\"id\": \"1\", \"question\": \"Is breakfast included?\", \"answer\": \"Yes, breakfast is served from 7:00 to 10:30.\", \"order\": 0}]",
        "name": "Hotel Lumiere",
        "publishedAt": "2026-03-16T11:00:00Z",
        "shortDescription": "Boutique hotel and restaurant in Lyon",
        "slug": "hotel-lumiere",
        "tags": "hotel,restaurant,lyon",
        "website": "https://example.com"
      }
    }
  ]
}
```

### Parameters

`slug` string 

path

Required

`include` array of string 

query

Related objects to include in the response

List of related objects to include. Supported values: 'workspace'

### Response

200

`builtIn` boolean

Whether the template is maintained by Linkbreakers (available to every workspace)

`description` string

Short marketing description displayed in the template picker

`faq` string

FAQ data stored as JSON.

Frequently Asked Questions about this template stored as JSON

`learnMore` string

Extended markdown-supported content providing detailed information about the template

`name` string

Human-readable name shown in the gallery

`publishedAt` string (date-time)

When the template was published and made available to all workspaces

`slug` string

Slug used in public template selection URLs

`tags` string

Tags for categorizing and filtering templates (comma-separated)

`thumbnailSignedUrl` string

Signed thumbnail preview of the template design

`workspace` object

Public information about the workspace that created this template. Empty for built-in templates. Only included when 'workspace' is specified in the include parameter.

8 child attributes

`description` string

Optional description providing additional context about the workspace

`faq` string

FAQ data stored as JSON.

Frequently Asked Questions about this workspace stored as JSON

`name` string

Human-readable display name

`publishedAt` string (date-time)

Timestamp when the workspace was published/made public

`shortDescription` string

Short description for the workspace

`slug` string

Unique slug for the workspace (URL-friendly identifier)

`tags` string

Comma-separated tags for the workspace

`website` string

Website URL for the workspace

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/public/qrcode-templates/{slug}"
```

Response 200

```json
{
  "builtIn": false,
  "description": "Rounded navy dots on a cream background, with room for your logo in the centre.",
  "faq": "{\"items\": [{\"id\": \"1\", \"question\": \"Can I put my own logo in the middle?\", \"answer\": \"Yes, upload it on the design and the dots behind it are hidden.\", \"order\": 1}]}",
  "learnMore": "## When to use it\nTable cards and menus where the QR code should match a warm, classic decor.",
  "name": "Bistro Navy",
  "publishedAt": "2026-03-18T16:05:00Z",
  "slug": "bistro-navy",
  "tags": "restaurant,menu,elegant",
  "thumbnailSignedUrl": "https://cdn.linkbreakers.com/qrcode-templates/0d7f4d9c/thumbnail.png",
  "workspace": {
    "description": "Boutique hotel in Lyon with a restaurant and a rooftop bar. Our QR codes sit on restaurant tables, flyers and posters.",
    "faq": "[{\"id\": \"1\", \"question\": \"Is breakfast included?\", \"answer\": \"Yes, breakfast is served from 7:00 to 10:30.\", \"order\": 0}]",
    "name": "Hotel Lumiere",
    "publishedAt": "2026-03-16T11:00:00Z",
    "shortDescription": "Boutique hotel and restaurant in Lyon",
    "slug": "hotel-lumiere",
    "tags": "hotel,restaurant,lyon",
    "website": "https://example.com"
  }
}
```

### Parameters

`include` array of string 

query

`search` string 

query

`pageSize` integer (int64) 

query

`pageToken` string 

query

`scope` string 

query

Which templates to return. WORKSPACE (default) returns only templates owned by the caller's workspace. AVAILABLE also returns built-in templates and templates other workspaces have published, ordered by the workspace's own usage first, then its own templates, then the rest.

* QRCODE\_TEMPLATE\_SCOPE\_UNSPECIFIED: Defaults to QRCODE\_TEMPLATE\_SCOPE\_WORKSPACE.
* QRCODE\_TEMPLATE\_SCOPE\_WORKSPACE: Only templates owned by the caller's workspace.
* QRCODE\_TEMPLATE\_SCOPE\_AVAILABLE: Every template the workspace may use: its own, built-in ones, and templates published by other workspaces.

`cursor` string 

query

Opaque cursor from the previous page's nextPageToken. Same as pageToken; when both are sent, pageToken wins.

### Response

200

`hasMore` boolean

Whether another page exists after this result set

`nextPageToken` string

Cursor token for the next page, if any.

Cursor token returned when another page is available

`qrcodeTemplates` array of object

Fields: [The qr code template object](#qr-code-templates-object).

`totalCount` integer (int64)

How many records exist in total, so a client can tell a complete answer from a page of one. A local-first client reads absence from this list as deletion, and may only do so when the count it was given matches what it received: without that, one page would look like the whole model and everything beyond it would be removed locally.

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/qrcode-templates" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Response 200

```json
{
  "hasMore": true,
  "nextPageToken": "eyJxdHMiOiJxdGVtcGxhdGUifQ==",
  "qrcodeTemplates": [
    {
      "builtIn": false,
      "createdAt": "2026-03-14T09:30:00Z",
      "description": "Rounded navy dots on a cream background, with room for your logo in the centre.",
      "duplicatedFrom": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
      "faq": "{\"items\": [{\"id\": \"1\", \"question\": \"Can I put my own logo in the middle?\", \"answer\": \"Yes, upload it on the design and the dots behind it are hidden.\", \"order\": 1}]}",
      "id": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
      "learnMore": "## When to use it\nTable cards and menus where the QR code should match a warm, classic decor.",
      "name": "Bistro Navy",
      "owned": true,
      "publishedAt": "2026-03-18T16:05:00Z",
      "qrcodeDesign": {
        "backgroundOptions": {
          "themeColor": {
            "colors": [
              "#1F3A5F",
              "#F4EDE4"
            ],
            "direction": "135deg",
            "stops": [
              "0%",
              "100%"
            ],
            "type": "THEME_COLOR_TYPE_LINEAR"
          }
        },
        "centralImageMargin": 8,
        "centralImageMediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f",
        "centralImageSignedUrl": "https://cdn.linkbreakers.com/media/5f1c2d3e/menu-cover.png",
        "centralImageSize": 0.3,
        "cornersDotOptions": {
          "themeColor": {
            "colors": [
              "#1F3A5F",
              "#F4EDE4"
            ],
            "direction": "135deg",
            "stops": [
              "0%",
              "100%"
            ],
            "type": "THEME_COLOR_TYPE_LINEAR"
          },
          "type": "CORNERS_DOT_TYPE_DOT"
        },
        "cornersSquareOptions": {
          "themeColor": {
            "colors": [
              "#1F3A5F",
              "#F4EDE4"
            ],
            "direction": "135deg",
            "stops": [
              "0%",
              "100%"
            ],
            "type": "THEME_COLOR_TYPE_LINEAR"
          },
          "type": "CORNERS_SQUARE_TYPE_EXTRA_ROUNDED"
        },
        "createdAt": "2026-03-14T09:30:00Z",
        "dotsOptions": {
          "themeColor": {
            "colors": [
              "#1F3A5F",
              "#F4EDE4"
            ],
            "direction": "135deg",
            "stops": [
              "0%",
              "100%"
            ],
            "type": "THEME_COLOR_TYPE_LINEAR"
          },
          "type": "DOTS_TYPE_ROUNDED"
        },
        "errorCorrectionLevel": "H",
        "hasCentralImage": true,
        "height": 1024,
        "hideBackgroundDots": true,
        "id": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
        "outputFileFormat": "OUTPUT_FILE_FORMAT_PNG",
        "shape": "SHAPE_SQUARE",
        "updatedAt": "2026-03-18T16:05:00Z",
        "width": 1024
      },
      "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
      "slug": "bistro-navy",
      "tags": "restaurant,menu,elegant",
      "thumbnailPendingUpdateSince": "2026-03-18T16:05:00Z",
      "thumbnailSignedUrl": "https://cdn.linkbreakers.com/qrcode-templates/0d7f4d9c/thumbnail.png",
      "updatedAt": "2026-03-18T16:05:00Z",
      "usageCount": 12,
      "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
    }
  ],
  "totalCount": 24
}
```

### Parameters

`id` string 

path

Required

`include` array of string 

query

### Response

200

Returns [the qr code template object](#qr-code-templates-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/qrcode-templates/{id}" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

### Parameters

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

`description` string

The description of the QR code template

`faq` string

FAQ data stored as JSON

`learnMore` string

Extended markdown-supported content providing detailed information about the template

`name` string

The name of the QR code template

`qrcodeDesignId` string

The ID of a fresh QR code design to use for this template (UUID) NOTE: The design must not be used by any other links or templates.

The QR code design must be a fresh design not used elsewhere to ensure template independence

`tags` string

Tags for categorizing and filtering templates (comma-separated)

### Response

200

`qrcodeTemplate` object

The created QR code template

Fields: [The qr code template object](#qr-code-templates-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X POST "https://api.linkbreakers.com/v1/qrcode-templates" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "description": "Rounded navy dots on a cream background, with room for your logo in the centre.",
  "faq": "{\"items\": [{\"id\": \"1\", \"question\": \"Can I put my own logo in the middle?\", \"answer\": \"Yes, upload it on the design and the dots behind it are hidden.\", \"order\": 1}]}",
  "learnMore": "## When to use it\nTable cards and menus where the QR code should match a warm, classic decor.",
  "name": "Bistro Navy",
  "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
  "tags": "restaurant,menu,elegant"
}'
```

Response 200

```json
{
  "qrcodeTemplate": {
    "builtIn": false,
    "createdAt": "2026-03-14T09:30:00Z",
    "description": "Rounded navy dots on a cream background, with room for your logo in the centre.",
    "duplicatedFrom": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
    "faq": "{\"items\": [{\"id\": \"1\", \"question\": \"Can I put my own logo in the middle?\", \"answer\": \"Yes, upload it on the design and the dots behind it are hidden.\", \"order\": 1}]}",
    "id": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
    "learnMore": "## When to use it\nTable cards and menus where the QR code should match a warm, classic decor.",
    "name": "Bistro Navy",
    "owned": true,
    "publishedAt": "2026-03-18T16:05:00Z",
    "qrcodeDesign": {
      "backgroundOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        }
      },
      "centralImageMargin": 8,
      "centralImageMediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f",
      "centralImageSignedUrl": "https://cdn.linkbreakers.com/media/5f1c2d3e/menu-cover.png",
      "centralImageSize": 0.3,
      "cornersDotOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        },
        "type": "CORNERS_DOT_TYPE_DOT"
      },
      "cornersSquareOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        },
        "type": "CORNERS_SQUARE_TYPE_EXTRA_ROUNDED"
      },
      "createdAt": "2026-03-14T09:30:00Z",
      "dotsOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        },
        "type": "DOTS_TYPE_ROUNDED"
      },
      "errorCorrectionLevel": "H",
      "hasCentralImage": true,
      "height": 1024,
      "hideBackgroundDots": true,
      "id": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
      "outputFileFormat": "OUTPUT_FILE_FORMAT_PNG",
      "shape": "SHAPE_SQUARE",
      "updatedAt": "2026-03-18T16:05:00Z",
      "width": 1024
    },
    "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
    "slug": "bistro-navy",
    "tags": "restaurant,menu,elegant",
    "thumbnailPendingUpdateSince": "2026-03-18T16:05:00Z",
    "thumbnailSignedUrl": "https://cdn.linkbreakers.com/qrcode-templates/0d7f4d9c/thumbnail.png",
    "updatedAt": "2026-03-18T16:05:00Z",
    "usageCount": 12,
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}
```

### Parameters

`id` string 

path

Required

The ID of the QR code template to publish (UUID)

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

An empty JSON object.

### Response

200

`qrcodeTemplate` object

The published QR code template

Fields: [The qr code template object](#qr-code-templates-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X POST "https://api.linkbreakers.com/v1/qrcode-templates/{id}/publish" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json"
```

Response 200

```json
{
  "qrcodeTemplate": {
    "builtIn": false,
    "createdAt": "2026-03-14T09:30:00Z",
    "description": "Rounded navy dots on a cream background, with room for your logo in the centre.",
    "duplicatedFrom": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
    "faq": "{\"items\": [{\"id\": \"1\", \"question\": \"Can I put my own logo in the middle?\", \"answer\": \"Yes, upload it on the design and the dots behind it are hidden.\", \"order\": 1}]}",
    "id": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
    "learnMore": "## When to use it\nTable cards and menus where the QR code should match a warm, classic decor.",
    "name": "Bistro Navy",
    "owned": true,
    "publishedAt": "2026-03-18T16:05:00Z",
    "qrcodeDesign": {
      "backgroundOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        }
      },
      "centralImageMargin": 8,
      "centralImageMediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f",
      "centralImageSignedUrl": "https://cdn.linkbreakers.com/media/5f1c2d3e/menu-cover.png",
      "centralImageSize": 0.3,
      "cornersDotOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        },
        "type": "CORNERS_DOT_TYPE_DOT"
      },
      "cornersSquareOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        },
        "type": "CORNERS_SQUARE_TYPE_EXTRA_ROUNDED"
      },
      "createdAt": "2026-03-14T09:30:00Z",
      "dotsOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        },
        "type": "DOTS_TYPE_ROUNDED"
      },
      "errorCorrectionLevel": "H",
      "hasCentralImage": true,
      "height": 1024,
      "hideBackgroundDots": true,
      "id": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
      "outputFileFormat": "OUTPUT_FILE_FORMAT_PNG",
      "shape": "SHAPE_SQUARE",
      "updatedAt": "2026-03-18T16:05:00Z",
      "width": 1024
    },
    "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
    "slug": "bistro-navy",
    "tags": "restaurant,menu,elegant",
    "thumbnailPendingUpdateSince": "2026-03-18T16:05:00Z",
    "thumbnailSignedUrl": "https://cdn.linkbreakers.com/qrcode-templates/0d7f4d9c/thumbnail.png",
    "updatedAt": "2026-03-18T16:05:00Z",
    "usageCount": 12,
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}
```

### Parameters

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

`slug` string

The slug of the public QR code template to import into your workspace

### Response

200

`qrcodeTemplate` object

The imported QR code template (now owned by the importing workspace)

Fields: [The qr code template object](#qr-code-templates-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X POST "https://api.linkbreakers.com/v1/qrcode-templates/import" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "slug": "minimalist-corporate"
}'
```

Response 200

```json
{
  "qrcodeTemplate": {
    "builtIn": false,
    "createdAt": "2026-03-14T09:30:00Z",
    "description": "Rounded navy dots on a cream background, with room for your logo in the centre.",
    "duplicatedFrom": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
    "faq": "{\"items\": [{\"id\": \"1\", \"question\": \"Can I put my own logo in the middle?\", \"answer\": \"Yes, upload it on the design and the dots behind it are hidden.\", \"order\": 1}]}",
    "id": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
    "learnMore": "## When to use it\nTable cards and menus where the QR code should match a warm, classic decor.",
    "name": "Bistro Navy",
    "owned": true,
    "publishedAt": "2026-03-18T16:05:00Z",
    "qrcodeDesign": {
      "backgroundOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        }
      },
      "centralImageMargin": 8,
      "centralImageMediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f",
      "centralImageSignedUrl": "https://cdn.linkbreakers.com/media/5f1c2d3e/menu-cover.png",
      "centralImageSize": 0.3,
      "cornersDotOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        },
        "type": "CORNERS_DOT_TYPE_DOT"
      },
      "cornersSquareOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        },
        "type": "CORNERS_SQUARE_TYPE_EXTRA_ROUNDED"
      },
      "createdAt": "2026-03-14T09:30:00Z",
      "dotsOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        },
        "type": "DOTS_TYPE_ROUNDED"
      },
      "errorCorrectionLevel": "H",
      "hasCentralImage": true,
      "height": 1024,
      "hideBackgroundDots": true,
      "id": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
      "outputFileFormat": "OUTPUT_FILE_FORMAT_PNG",
      "shape": "SHAPE_SQUARE",
      "updatedAt": "2026-03-18T16:05:00Z",
      "width": 1024
    },
    "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
    "slug": "bistro-navy",
    "tags": "restaurant,menu,elegant",
    "thumbnailPendingUpdateSince": "2026-03-18T16:05:00Z",
    "thumbnailSignedUrl": "https://cdn.linkbreakers.com/qrcode-templates/0d7f4d9c/thumbnail.png",
    "updatedAt": "2026-03-18T16:05:00Z",
    "usageCount": 12,
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}
```

### Parameters

`id` string 

path

Required

The ID of the QR code template to update (UUID)

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

`description` string

The new description of the QR code template

`faq` string

FAQ data to update (JSON string)

`learnMore` string

Extended markdown-supported content providing detailed information about the template

`name` string

The new name of the QR code template

`slug` string

The new slug for the QR code template (must be unique globally)

`tags` string

The new tags for the QR code template (comma-separated)

### Response

200

`qrcodeTemplate` object

The updated QR code template

Fields: [The qr code template object](#qr-code-templates-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X PATCH "https://api.linkbreakers.com/v1/qrcode-templates/{id}" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "description": "Rounded navy dots on a cream background, with room for your logo in the centre.",
  "faq": "{\"items\": [{\"id\": \"1\", \"question\": \"Can I put my own logo in the middle?\", \"answer\": \"Yes, upload it on the design and the dots behind it are hidden.\", \"order\": 1}]}",
  "learnMore": "## When to use it\nTable cards and menus where the QR code should match a warm, classic decor.",
  "name": "Bistro Navy",
  "slug": "bistro-navy",
  "tags": "restaurant,menu,elegant"
}'
```

Response 200

```json
{
  "qrcodeTemplate": {
    "builtIn": false,
    "createdAt": "2026-03-14T09:30:00Z",
    "description": "Rounded navy dots on a cream background, with room for your logo in the centre.",
    "duplicatedFrom": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
    "faq": "{\"items\": [{\"id\": \"1\", \"question\": \"Can I put my own logo in the middle?\", \"answer\": \"Yes, upload it on the design and the dots behind it are hidden.\", \"order\": 1}]}",
    "id": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
    "learnMore": "## When to use it\nTable cards and menus where the QR code should match a warm, classic decor.",
    "name": "Bistro Navy",
    "owned": true,
    "publishedAt": "2026-03-18T16:05:00Z",
    "qrcodeDesign": {
      "backgroundOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        }
      },
      "centralImageMargin": 8,
      "centralImageMediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f",
      "centralImageSignedUrl": "https://cdn.linkbreakers.com/media/5f1c2d3e/menu-cover.png",
      "centralImageSize": 0.3,
      "cornersDotOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        },
        "type": "CORNERS_DOT_TYPE_DOT"
      },
      "cornersSquareOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        },
        "type": "CORNERS_SQUARE_TYPE_EXTRA_ROUNDED"
      },
      "createdAt": "2026-03-14T09:30:00Z",
      "dotsOptions": {
        "themeColor": {
          "colors": [
            "#1F3A5F",
            "#F4EDE4"
          ],
          "direction": "135deg",
          "stops": [
            "0%",
            "100%"
          ],
          "type": "THEME_COLOR_TYPE_LINEAR"
        },
        "type": "DOTS_TYPE_ROUNDED"
      },
      "errorCorrectionLevel": "H",
      "hasCentralImage": true,
      "height": 1024,
      "hideBackgroundDots": true,
      "id": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
      "outputFileFormat": "OUTPUT_FILE_FORMAT_PNG",
      "shape": "SHAPE_SQUARE",
      "updatedAt": "2026-03-18T16:05:00Z",
      "width": 1024
    },
    "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
    "slug": "bistro-navy",
    "tags": "restaurant,menu,elegant",
    "thumbnailPendingUpdateSince": "2026-03-18T16:05:00Z",
    "thumbnailSignedUrl": "https://cdn.linkbreakers.com/qrcode-templates/0d7f4d9c/thumbnail.png",
    "updatedAt": "2026-03-18T16:05:00Z",
    "usageCount": 12,
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}
```

### Parameters

`id` string 

path

Required

### Response

200

An empty JSON object.

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X DELETE "https://api.linkbreakers.com/v1/qrcode-templates/{id}" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

---

Source: https://linkbreakers.com/help/api/qr-code-templates
