#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

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

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

Learn more

Learn more about page themes in Linkbreakers.

Example object

{
  "badgeEnabled": false,
  "badgeIconColor": {
    "colors": [
      "string"
    ],
    "direction": "string",
    "stops": [
      "string"
    ],
    "type": "THEME_COLOR_TYPE_UNSPECIFIED"
  },
  "badgeId": "string",
  "badgeShape": "PAGE_THEME_BADGE_SHAPE_UNSPECIFIED",
  "bodyFont": {
    "bold": false,
    "color": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
    "fontSize": 0,
    "italic": false
  },
  "canvasColor": {
    "colors": [
      "string"
    ],
    "direction": "string",
    "stops": [
      "string"
    ],
    "type": "THEME_COLOR_TYPE_UNSPECIFIED"
  },
  "canvasCoverId": "string",
  "canvasCoverMode": "PAGE_THEME_BACKGROUND_COVER_MODE_UNSPECIFIED",
  "containerConfig": {
    "backgroundColor": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "borderColor": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "borderSize": 0,
    "borderStyle": "PAGE_THEME_BORDER_STYLE_UNSPECIFIED",
    "opacity": 0,
    "variant": "PAGE_THEME_CONTAINER_VARIANT_UNSPECIFIED"
  },
  "createdAt": "2026-02-27T00:08:58.145Z",
  "elementColor": {
    "colors": [
      "string"
    ],
    "direction": "string",
    "stops": [
      "string"
    ],
    "type": "THEME_COLOR_TYPE_UNSPECIFIED"
  },
  "elementFont": {
    "bold": false,
    "color": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
    "fontSize": 0,
    "italic": false
  },
  "id": "string",
  "titleFont": {
    "bold": false,
    "color": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
    "fontSize": 0,
    "italic": false
  },
  "updatedAt": "2026-02-27T00:08:58.145Z",
  "workspaceId": "string"
}

GET/v1/page-themesRequires auth

#List page themes for the current workspace

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

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

pageThemes

array<object>

List of page themes

#Error response

400-599

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

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/page-themes" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "pageThemes": [
    {
      "badgeEnabled": false,
      "badgeIconColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "badgeId": "string",
      "badgeShape": "PAGE_THEME_BADGE_SHAPE_UNSPECIFIED",
      "bodyFont": {
        "bold": false,
        "color": {},
        "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
        "fontSize": 0,
        "italic": false
      },
      "canvasColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "canvasCoverId": "string",
      "canvasCoverMode": "PAGE_THEME_BACKGROUND_COVER_MODE_UNSPECIFIED",
      "containerConfig": {
        "backgroundColor": {},
        "borderColor": {},
        "borderSize": 0,
        "borderStyle": "PAGE_THEME_BORDER_STYLE_UNSPECIFIED",
        "opacity": 0,
        "variant": "PAGE_THEME_CONTAINER_VARIANT_UNSPECIFIED"
      },
      "createdAt": "2026-02-27T00:08:58.144Z",
      "elementColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "elementFont": {
        "bold": false,
        "color": {},
        "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
        "fontSize": 0,
        "italic": false
      },
      "id": "string",
      "titleFont": {
        "bold": false,
        "color": {},
        "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
        "fontSize": 0,
        "italic": false
      },
      "updatedAt": "2026-02-27T00:08:58.144Z",
      "workspaceId": "string"
    }
  ]
}

Base URL: https://api.linkbreakers.com

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

#Get a page theme

Retrieves a specific page theme by ID.

#Parameters

path parameters

stringRequiredpath

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

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/page-themes/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "pageTheme": {
    "badgeEnabled": false,
    "badgeIconColor": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "badgeId": "string",
    "badgeShape": "PAGE_THEME_BADGE_SHAPE_UNSPECIFIED",
    "bodyFont": {
      "bold": false,
      "color": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
      "fontSize": 0,
      "italic": false
    },
    "canvasColor": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "canvasCoverId": "string",
    "canvasCoverMode": "PAGE_THEME_BACKGROUND_COVER_MODE_UNSPECIFIED",
    "containerConfig": {
      "backgroundColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "borderColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "borderSize": 0,
      "borderStyle": "PAGE_THEME_BORDER_STYLE_UNSPECIFIED",
      "opacity": 0,
      "variant": "PAGE_THEME_CONTAINER_VARIANT_UNSPECIFIED"
    },
    "createdAt": "2026-02-27T00:08:58.144Z",
    "elementColor": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "elementFont": {
      "bold": false,
      "color": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
      "fontSize": 0,
      "italic": false
    },
    "id": "string",
    "titleFont": {
      "bold": false,
      "color": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
      "fontSize": 0,
      "italic": false
    },
    "updatedAt": "2026-02-27T00:08:58.144Z",
    "workspaceId": "string"
  }
}

Base URL: https://api.linkbreakers.com

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

stringRequiredpath

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

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

objectRequired

Wrapped error response.

Example request (cURL)

curl -X PATCH "https://api.linkbreakers.com/v1/page-themes/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"badge":{"delete":{},"id":"string"},"badgeEnabled":false,"badgeIconColor":{"colors":["string"],"direction":"string","stops":["string"],"type":"THEME_COLOR_TYPE_UNSPECIFIED"},"badgeShape":"PAGE_THEME_BADGE_SHAPE_UNSPECIFIED","bodyFont":{"bold":false,"color":{"colors":["string"],"direction":"string","stops":["string"],"type":"THEME_COLOR_TYPE_UNSPECIFIED"},"family":"PAGE_THEME_FONT_FAMILY_UNSPECIFIED","fontSize":0,"italic":false},"canvasColor":{"colors":["string"],"direction":"string","stops":["string"],"type":"THEME_COLOR_TYPE_UNSPECIFIED"},"canvasCover":{"delete":{},"id":"string"},"canvasCoverMode":"PAGE_THEME_BACKGROUND_COVER_MODE_UNSPECIFIED","containerConfig":{"backgroundColor":{"colors":["string"],"direction":"string","stops":["string"],"type":"THEME_COLOR_TYPE_UNSPECIFIED"},"borderColor":{"colors":["string"],"direction":"string","stops":["string"],"type":"THEME_COLOR_TYPE_UNSPECIFIED"},"borderSize":0,"borderStyle":"PAGE_THEME_BORDER_STYLE_UNSPECIFIED","opacity":0,"variant":"PAGE_THEME_CONTAINER_VARIANT_UNSPECIFIED"},"elementColor":{"colors":["string"],"direction":"string","stops":["string"],"type":"THEME_COLOR_TYPE_UNSPECIFIED"},"elementFont":{"bold":false,"color":{"colors":["string"],"direction":"string","stops":["string"],"type":"THEME_COLOR_TYPE_UNSPECIFIED"},"family":"PAGE_THEME_FONT_FAMILY_UNSPECIFIED","fontSize":0,"italic":false},"titleFont":{"bold":false,"color":{"colors":["string"],"direction":"string","stops":["string"],"type":"THEME_COLOR_TYPE_UNSPECIFIED"},"family":"PAGE_THEME_FONT_FAMILY_UNSPECIFIED","fontSize":0,"italic":false}}'

Sample payload (application/json)

{
  "badge": {
    "delete": {},
    "id": "string"
  },
  "badgeEnabled": false,
  "badgeIconColor": {
    "colors": [
      "string"
    ],
    "direction": "string",
    "stops": [
      "string"
    ],
    "type": "THEME_COLOR_TYPE_UNSPECIFIED"
  },
  "badgeShape": "PAGE_THEME_BADGE_SHAPE_UNSPECIFIED",
  "bodyFont": {
    "bold": false,
    "color": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
    "fontSize": 0,
    "italic": false
  },
  "canvasColor": {
    "colors": [
      "string"
    ],
    "direction": "string",
    "stops": [
      "string"
    ],
    "type": "THEME_COLOR_TYPE_UNSPECIFIED"
  },
  "canvasCover": {
    "delete": {},
    "id": "string"
  },
  "canvasCoverMode": "PAGE_THEME_BACKGROUND_COVER_MODE_UNSPECIFIED",
  "containerConfig": {
    "backgroundColor": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "borderColor": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "borderSize": 0,
    "borderStyle": "PAGE_THEME_BORDER_STYLE_UNSPECIFIED",
    "opacity": 0,
    "variant": "PAGE_THEME_CONTAINER_VARIANT_UNSPECIFIED"
  },
  "elementColor": {
    "colors": [
      "string"
    ],
    "direction": "string",
    "stops": [
      "string"
    ],
    "type": "THEME_COLOR_TYPE_UNSPECIFIED"
  },
  "elementFont": {
    "bold": false,
    "color": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
    "fontSize": 0,
    "italic": false
  },
  "titleFont": {
    "bold": false,
    "color": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
    "fontSize": 0,
    "italic": false
  }
}

Typical response

{
  "pageTheme": {
    "badgeEnabled": false,
    "badgeIconColor": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "badgeId": "string",
    "badgeShape": "PAGE_THEME_BADGE_SHAPE_UNSPECIFIED",
    "bodyFont": {
      "bold": false,
      "color": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
      "fontSize": 0,
      "italic": false
    },
    "canvasColor": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "canvasCoverId": "string",
    "canvasCoverMode": "PAGE_THEME_BACKGROUND_COVER_MODE_UNSPECIFIED",
    "containerConfig": {
      "backgroundColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "borderColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "borderSize": 0,
      "borderStyle": "PAGE_THEME_BORDER_STYLE_UNSPECIFIED",
      "opacity": 0,
      "variant": "PAGE_THEME_CONTAINER_VARIANT_UNSPECIFIED"
    },
    "createdAt": "2026-02-27T00:08:58.144Z",
    "elementColor": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "THEME_COLOR_TYPE_UNSPECIFIED"
    },
    "elementFont": {
      "bold": false,
      "color": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
      "fontSize": 0,
      "italic": false
    },
    "id": "string",
    "titleFont": {
      "bold": false,
      "color": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
      "fontSize": 0,
      "italic": false
    },
    "updatedAt": "2026-02-27T00:08:58.144Z",
    "workspaceId": "string"
  }
}

Base URL: https://api.linkbreakers.com

Page Themes

#The Page Theme object

Allowed values

Allowed values

#List page themes for the current workspace

#Parameters

#Response

#Error response

#Get a page theme

#Parameters

path parameters

#Response

#Error response

#Update a page theme

#Parameters

path parameters

#Request body

Allowed values

Allowed values

#Response

#Error response