Logo of linkbreakers

Page Themes

Endpoints for managing page visual themes. These endpoints allow you to create, read, and update themes for canvas, cover, badge, container, typography, and interactive elements.

#The Page Theme object

Page theme configuration

badgeEnabled

boolean

--- Badge Section --- Whether badge is enabled

badgeIconColor

object

Reusable color payload used across design-oriented APIs (page themes, QR code designs, etc.). It supports solid colors and gradients with optional direction and per-stop offsets.

badgeId

string

Badge image ID (references media table)

badgeShape

string (enum)

Badge shape

Allowed values
PAGE_THEME_BADGE_SHAPE_UNSPECIFIED
PAGE_THEME_BADGE_SHAPE_CIRCLE
PAGE_THEME_BADGE_SHAPE_SQUARE
PAGE_THEME_BADGE_SHAPE_ROUNDED

bodyFont

object

Font configuration with family, styling, and color

canvasColor

object

Reusable color payload used across design-oriented APIs (page themes, QR code designs, etc.). It supports solid colors and gradients with optional direction and per-stop offsets.

canvasCoverId

string

Optional cover media ID (references media table)

canvasCoverMode

string (enum)

Cover display mode

Allowed values
PAGE_THEME_BACKGROUND_COVER_MODE_UNSPECIFIED
PAGE_THEME_BACKGROUND_COVER_MODE_FULL
PAGE_THEME_BACKGROUND_COVER_MODE_PROGRESSIVE_TOP
PAGE_THEME_BACKGROUND_COVER_MODE_PROGRESSIVE_BOTTOM

containerConfig

object

Container styling configuration

containerEnabled

boolean

Whether container is enabled

createdAt

string (date-time)

When the page theme was created

elementColor

object

Reusable color payload used across design-oriented APIs (page themes, QR code designs, etc.). It supports solid colors and gradients with optional direction and per-stop offsets.

elementFont

object

Font configuration with family, styling, and color

id

string

Page theme ID

titleFont

object

Font configuration with family, styling, and color

updatedAt

string (date-time)

When the page theme was last updated

workspaceId

string

Workspace ID this page theme belongs to

GET
/v1/page-themes
Requires auth

#List page themes for the current workspace

Retrieves all page themes belonging to the caller's workspace.

#Parameters

query parameters

pageSize

integer (int64)
query

Maximum number of page themes to return. Defaults to 100, capped at 1000.

pageToken

string
query

Cursor from a previous response's next_page_token. Empty starts at the first page. Pages are ordered by (created_at, id), which never change, so a record cannot move between pages while a client is walking them.

#Response

200

Everything worked as expected.

nextPageToken

string

Cursor to continue listing page themes. Empty on the last page.

pageThemes

array<object>

List of page themes

totalCount

string (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.

#Error response

400-599

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

error

object
Required

Wrapped error response.

GET
/v1/page-themes/{id}
Requires auth

#Get a page theme

Retrieves a specific page theme by ID.

#Parameters

path parameters

id

string
Required
path

Page theme ID to retrieve

#Response

200

Everything worked as expected.

pageTheme

object

Page theme configuration

#Error response

400-599

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

error

object
Required

Wrapped error response.

GET
/v1/page-themes/matching-template
Requires auth

#Find a page theme template matching a link's styling

Returns the page theme template available to the workspace whose styling is identical to the link's current page theme, if one exists. Saving the theme as a template again would only duplicate it.

#Parameters

query parameters

linkId

string
Required
query

Link whose current page theme should be matched

#Response

200

Everything worked as expected.

matched

boolean

Whether the link's styling already exists as a template

pageThemeTemplate

object

Reusable page styling presets that help teams give every link page a consistent look.

#Error response

400-599

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

error

object
Required

Wrapped error response.

POST
/v1/page-themes/apply-template
Requires auth

#Apply a page theme template to a link

Copies a template's styling into the link's own page theme. The link keeps its own theme row, so the template can later be edited or deleted without changing any page that was styled from it. Cover and badge media are copied into the caller's workspace when the template carries them.

#Parameters

This endpoint does not accept any parameters.

#Request body

linkId

string
Required

Link whose page theme should be restyled

pageThemeTemplateId

string

Template to apply, addressed by ID. Use this for workspace templates that have not been published and therefore have no slug.

slug

string

Slug of the page theme template to apply. Only published and built-in templates carry a slug: it is the public identifier the gallery and the marketing site address them by. Supply page_theme_template_id instead for a workspace's own drafts, which have none. Exactly one of the two is required.

#Response

200

Everything worked as expected.

pageTheme

object

Page theme configuration

#Error response

400-599

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

error

object
Required

Wrapped error response.

PATCH
/v1/page-themes/{id}
Requires auth

#Update a page theme

Updates an existing page theme. Cannot update page themes that are currently attached to links.

#Parameters

path parameters

id

string
Required
path

Page theme ID to update

#Request body

badge

object

badgeEnabled

boolean

--- Badge Section --- Whether badge is enabled

badgeIconColor

object

Reusable color payload used across design-oriented APIs (page themes, QR code designs, etc.). It supports solid colors and gradients with optional direction and per-stop offsets.

badgeShape

string (enum)

Badge shape to update

Allowed values
PAGE_THEME_BADGE_SHAPE_UNSPECIFIED
PAGE_THEME_BADGE_SHAPE_CIRCLE
PAGE_THEME_BADGE_SHAPE_SQUARE
PAGE_THEME_BADGE_SHAPE_ROUNDED

bodyFont

object

Font configuration with family, styling, and color

canvasColor

object

Reusable color payload used across design-oriented APIs (page themes, QR code designs, etc.). It supports solid colors and gradients with optional direction and per-stop offsets.

canvasCover

object

canvasCoverMode

string (enum)

Cover display mode to update

Allowed values
PAGE_THEME_BACKGROUND_COVER_MODE_UNSPECIFIED
PAGE_THEME_BACKGROUND_COVER_MODE_FULL
PAGE_THEME_BACKGROUND_COVER_MODE_PROGRESSIVE_TOP
PAGE_THEME_BACKGROUND_COVER_MODE_PROGRESSIVE_BOTTOM

containerConfig

object

Container styling configuration

containerEnabled

boolean

Whether container is enabled (false clears container_config)

elementColor

object

Reusable color payload used across design-oriented APIs (page themes, QR code designs, etc.). It supports solid colors and gradients with optional direction and per-stop offsets.

elementFont

object

Font configuration with family, styling, and color

titleFont

object

Font configuration with family, styling, and color

#Response

200

Everything worked as expected.

pageTheme

object

Page theme configuration

#Error response

400-599

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

error

object
Required

Wrapped error response.