Join us now
← Back to API Reference overview

Page Themes

Endpoints for managing page visual themes. These endpoints allow you to create, read, update page themes including background colors, button colors, and other visual elements that are rendered through a link.

Shortcut: ⌘K

#The Page Theme object

Page theme configuration

backgroundColor

object

Color configuration that can be a solid color or gradient

buttonColor

object

Color configuration that can be a solid color or gradient

createdAt

string (date-time)

When the page theme was created

id

string

Page theme ID

updatedAt

string (date-time)

When the page theme was last updated

workspaceId

string

Workspace ID this page theme belongs to

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.

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

#Get a page theme

Retrieves a specific page theme by ID.

#Parameters

path parameters

id

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.

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

stringRequiredpath

Page theme ID to update

#Request body

backgroundColor

object

Color configuration that can be a solid color or gradient

buttonColor

object

Color configuration that can be a solid color or gradient

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