Skip to main content
GET
Get a brand link page

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<shortuuid>
required

URL-safe brand identifier.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
page_id
string<shortuuid>
required

Identifier of the page, as listed.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

A brand-styled link-in-bio page made of ordered blocks.

id
string<shortuuid>
required

Identifier of the page.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
name
string
required

Internal label shown to brand managers when picking a page for a rule.

brand_name_override
string
required

Header brand name shown instead of the brand's own; empty to use the brand's name.

tagline
string
required

One-line tagline under the brand name; empty when none.

primary_color
string
required

Header background colour, a 6-digit hex value such as #0a84ff.

accent_color
string
required

Button and link colour, a 6-digit hex value such as #ff9500.

created
string<date-time>
required

ISO-8601 creation timestamp.

modified
string<date-time>
required

ISO-8601 last-modified timestamp.

button_style
enum<string>
required

Link buttons are filled or outlined.

Available options:
filled,
outlined
button_shape
enum<string>
required

Link buttons are rounded or square.

Available options:
rounded,
square
blocks
Blocks · object[]
required

Ordered blocks, each a {type, data} object. Types: link, section_header, image_carousel and countdown_timer. A malformed block is refused with 422.