Join us now
← Back to API Reference overview

QR Code Templates

Endpoints for managing QR Code Templates in Linkbreakers. These endpoints allow you to create, retrieve, update, and delete QR Code Templates.

Shortcut: ⌘K

#The QR Code Template object

Provides the reusable presets Linkbreakers suggests when teams create new links, bundling a design and copy so campaigns start with on-brand defaults. Templates can be either private (default) or public: - Private templates (published_at is null): Only visible to the creating workspace - Public templates (published_at is set): Visible to all workspaces in the gallery - Built-in templates: Always public and maintained by Linkbreakers

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

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

publishedAt

string (date-time)

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

qrcodeDesign

object

Captures the visual recipe Linkbreakers uses when rendering downloadable QR codes, including colors, shapes, export options, and center media. QR Code Designs are the visual representation of a link. They can be attached to QR Code Templates for reusability. They can only be attached to one record at a time.

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

workspaceId

string

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

GET/v1/public/qrcode-templatesRequires auth

#List QR code templates

Retrieve available QR code templates, optionally filtered by search terms or link destination.

#Parameters

query parameters

include

array<string>query

Related objects to include in the response List of related objects to include. Supported values: 'workspace'

search

stringquery

Search query applied to template name/description

pageSize

integer (int32)query

Maximum number of templates to return (defaults to 20)

pageToken

stringquery

Cursor token to retrieve the next page of results

workspaceId

stringquery

Optional workspace ID to filter templates by workspace Filter public templates by workspace. Only published templates for that workspace will be returned.

#Response

200

Everything worked as expected.

hasMore

boolean

Whether another page exists after this result set

nextPageToken

string

Cursor token returned when another page is available

qrcodeTemplates

array<object>

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

GET/v1/public/qrcode-templates/{slug}Requires auth

#Get a public QR code template

Retrieve a single published QR code template that is visible in the public gallery.

#Parameters

path parameters

slug

stringRequiredpath

query parameters

include

array<string>query

Related objects to include in the response List of related objects to include. Supported values: 'workspace'

#Response

200

Everything worked as expected.

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

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

PublicWorkspace represents a publicly visible workspace with limited data

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

GET/v1/qrcode-templatesRequires auth

#List my QR code templates

Retrieve QR code templates that belong to the authenticated caller's workspace.

#Parameters

query parameters

include

array<string>query

search

stringquery

pageSize

integer (int32)query

pageToken

stringquery

#Response

200

Everything worked as expected.

bestFitId

string

The design template that fits best the user's needs This is resolved from the linkDestination if given Returns the template ID to auto-select on the client (UUID)

hasMore

boolean

Whether another page exists after this result set

nextPageToken

string

Cursor token returned when another page is available

qrcodeTemplates

array<object>

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

GET/v1/qrcode-templates/{id}Requires auth

#Get a workspace QR code template

Retrieve a QR code template that belongs to the authenticated caller's workspace.

#Parameters

path parameters

id

stringRequiredpath

query parameters

include

array<string>query

#Response

200

Everything worked as expected.

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

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

publishedAt

string (date-time)

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

qrcodeDesign

object

Captures the visual recipe Linkbreakers uses when rendering downloadable QR codes, including colors, shapes, export options, and center media. QR Code Designs are the visual representation of a link. They can be attached to QR Code Templates for reusability. They can only be attached to one record at a time.

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

workspaceId

string

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

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

POST/v1/qrcode-templatesRequires auth

#Create a new QR code template

Create a new QR code template using a fresh design. The design must not be used by any other links or templates.

#Parameters

This endpoint does not accept any parameters.

#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 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

Everything worked as expected.

qrcodeTemplate

object

Provides the reusable presets Linkbreakers suggests when teams create new links, bundling a design and copy so campaigns start with on-brand defaults. Templates can be either private (default) or public: - Private templates (published_at is null): Only visible to the creating workspace - Public templates (published_at is set): Visible to all workspaces in the gallery - Built-in templates: Always public and maintained by Linkbreakers

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

POST/v1/qrcode-templates/{id}/publishRequires auth

#Publish a workspace QR code template

Publish a QR code template to make it available in the public gallery. Requires workspace to be public and template to have slug, description, and name.

#Parameters

path parameters

id

stringRequiredpath

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

#Request body

No structured schema available for this section.

#Response

200

Everything worked as expected.

qrcodeTemplate

object

Provides the reusable presets Linkbreakers suggests when teams create new links, bundling a design and copy so campaigns start with on-brand defaults. Templates can be either private (default) or public: - Private templates (published_at is null): Only visible to the creating workspace - Public templates (published_at is set): Visible to all workspaces in the gallery - Built-in templates: Always public and maintained by Linkbreakers

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

POST/v1/qrcode-templates/importRequires auth

#Import a public QR code template

Import a public QR code template into your workspace by slug. Creates a private copy owned by your workspace.

#Parameters

This endpoint does not accept any parameters.

#Request body

slug

string

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

#Response

200

Everything worked as expected.

qrcodeTemplate

object

Provides the reusable presets Linkbreakers suggests when teams create new links, bundling a design and copy so campaigns start with on-brand defaults. Templates can be either private (default) or public: - Private templates (published_at is null): Only visible to the creating workspace - Public templates (published_at is set): Visible to all workspaces in the gallery - Built-in templates: Always public and maintained by Linkbreakers

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

PATCH/v1/qrcode-templates/{id}Requires auth

#Update a workspace QR code template

Modify the name or description of a QR code template owned by the authenticated workspace.

#Parameters

path parameters

id

stringRequiredpath

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

#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

Everything worked as expected.

qrcodeTemplate

object

Provides the reusable presets Linkbreakers suggests when teams create new links, bundling a design and copy so campaigns start with on-brand defaults. Templates can be either private (default) or public: - Private templates (published_at is null): Only visible to the creating workspace - Public templates (published_at is set): Visible to all workspaces in the gallery - Built-in templates: Always public and maintained by Linkbreakers

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

DELETE/v1/qrcode-templates/{id}Requires auth

#Delete a workspace QR code template

Remove a QR code template belonging to the authenticated caller's workspace.

#Parameters

path parameters

id

stringRequiredpath

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.