me.linkna.linkinbio

linkna.me

Documentation

A user's link-in-bio page containing cards, theme configuration, and social icons.

main record

A user's link-in-bio page containing cards, theme configuration, and social icons.

Record Key literal:self Fixed literal value

Properties

socialIcons array of ref #socialIcon Optional

Social media icons displayed on the profile.

theme string Optional

Deprecated: use themeConfig instead.

themeConfig ref #themeConfig Optional

No description available.

View raw schema 
{
  "key": "literal:self",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "cards"
    ],
    "properties": {
      "cards": {
        "type": "array",
        "items": {
          "refs": [
            "#linkCard",
            "#widgetGoodreads",
            "#widgetGithub",
            "#widgetTealfm"
          ],
          "type": "union"
        },
        "description": "Ordered list of cards on the page. Each card is a union of linkCard, widgetGoodreads, widgetGithub, or widgetTealfm."
      },
      "theme": {
        "type": "string",
        "description": "Deprecated: use themeConfig instead."
      },
      "socialIcons": {
        "type": "array",
        "items": {
          "ref": "#socialIcon",
          "type": "ref"
        },
        "description": "Social media icons displayed on the profile."
      },
      "themeConfig": {
        "ref": "#themeConfig",
        "type": "ref"
      },
      "connectedServices": {
        "ref": "#connectedServices",
        "type": "ref"
      }
    }
  },
  "description": "A user's link-in-bio page containing cards, theme configuration, and social icons."
}
connectedServices object

Saved service credentials/identifiers for pre-filling widget forms.

Properties

githubUsername string Optional

GitHub username.

goodreadsUserId string Optional

Goodreads numeric user ID.

View raw schema 
{
  "type": "object",
  "properties": {
    "githubUsername": {
      "type": "string",
      "description": "GitHub username."
    },
    "goodreadsUserId": {
      "type": "string",
      "description": "Goodreads numeric user ID."
    }
  },
  "description": "Saved service credentials/identifiers for pre-filling widget forms."
}
githubContributionDay object

A single day's contribution data from GitHub.

Properties

count integer Required

Number of contributions on this day.

date string Required

Date in YYYY-MM-DD format.

level integer Required

Contribution intensity level (0=none, 4=highest).

minimum: 0maximum: 4
View raw schema 
{
  "type": "object",
  "required": [
    "date",
    "count",
    "level"
  ],
  "properties": {
    "date": {
      "type": "string",
      "description": "Date in YYYY-MM-DD format."
    },
    "count": {
      "type": "integer",
      "description": "Number of contributions on this day."
    },
    "level": {
      "type": "integer",
      "maximum": 4,
      "minimum": 0,
      "description": "Contribution intensity level (0=none, 4=highest)."
    }
  },
  "description": "A single day's contribution data from GitHub."
}
goodreadsBook object

A book from a Goodreads shelf.

Properties

author string Required

Book author.

coverUrl string Optional

URL to the book cover image.

rating integer Optional

User's rating (1-5), or absent if unrated.

minimum: 0maximum: 5
title string Required

Book title.

View raw schema 
{
  "type": "object",
  "required": [
    "title",
    "author"
  ],
  "properties": {
    "link": {
      "type": "string",
      "description": "URL to the book on Goodreads."
    },
    "title": {
      "type": "string",
      "description": "Book title."
    },
    "author": {
      "type": "string",
      "description": "Book author."
    },
    "rating": {
      "type": "integer",
      "maximum": 5,
      "minimum": 0,
      "description": "User's rating (1-5), or absent if unrated."
    },
    "coverUrl": {
      "type": "string",
      "description": "URL to the book cover image."
    }
  },
  "description": "A book from a Goodreads shelf."
}
linkCard object

A standard link card.

Properties

enabled boolean Optional

Whether the card is visible on the public page. Defaults to true.

highlighted boolean Optional

Whether the card is visually highlighted.

id string Optional

Unique identifier for the card.

text string Optional

Display text for the card (falls back to URL domain if empty).

maxLength: 100 bytes
type string Optional

Card type discriminator. Value: 'link' or absent for link cards.

url string uri Optional

URL the card links to.

View raw schema 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the card."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "URL the card links to."
    },
    "text": {
      "type": "string",
      "maxLength": 100,
      "description": "Display text for the card (falls back to URL domain if empty)."
    },
    "type": {
      "type": "string",
      "description": "Card type discriminator. Value: 'link' or absent for link cards."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the card is visible on the public page. Defaults to true."
    },
    "highlighted": {
      "type": "boolean",
      "description": "Whether the card is visually highlighted."
    }
  },
  "description": "A standard link card."
}
socialIcon object

A social media icon link.

Properties

id string Required

Unique identifier for the icon.

platform string Required

Platform identifier (e.g., 'bluesky', 'twitter', 'instagram').

url string uri Required

URL to the user's profile on this platform.

View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "platform",
    "url"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the icon."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "URL to the user's profile on this platform."
    },
    "platform": {
      "type": "string",
      "description": "Platform identifier (e.g., 'bluesky', 'twitter', 'instagram')."
    }
  },
  "description": "A social media icon link."
}
tealfmPlay object

A recently played track from teal.fm.

Properties

artistName string Required

Artist name(s).

coverUrl string Optional

URL to the album cover image (from Cover Art Archive).

originUrl string Optional

URL to the track on the original music service.

playedTime string datetime Optional

When the track was played.

releaseName string Optional

Album/release name.

trackName string Required

Track/song name.

View raw schema 
{
  "type": "object",
  "required": [
    "trackName",
    "artistName"
  ],
  "properties": {
    "coverUrl": {
      "type": "string",
      "description": "URL to the album cover image (from Cover Art Archive)."
    },
    "originUrl": {
      "type": "string",
      "description": "URL to the track on the original music service."
    },
    "trackName": {
      "type": "string",
      "description": "Track/song name."
    },
    "artistName": {
      "type": "string",
      "description": "Artist name(s)."
    },
    "playedTime": {
      "type": "string",
      "format": "datetime",
      "description": "When the track was played."
    },
    "releaseName": {
      "type": "string",
      "description": "Album/release name."
    }
  },
  "description": "A recently played track from teal.fm."
}
themeConfig object

Theme configuration for the page appearance.

Properties

backgroundColor string Optional

Page background color.

backgroundGradient string Optional

CSS gradient for the page background.

buttonAlignment string Optional

Button content alignment. Default: left.

Known values: left, right
buttonHoverGlow boolean Optional

Whether buttons glow on hover. Default: false.

buttonHoverGlowColor string Optional

Color for the button hover glow effect.

cardBackgroundColor string Optional

Individual card/button background color.

cardBorderColor string Optional

Card/button border color.

cardBorderRadius string Optional

Card/button border radius.

Known values: none, sm, md, lg, full
cardHoverColor string Optional

Card/button border color on hover.

cardShadow string Optional

Card/button shadow intensity.

Known values: none, sm, md, lg, xl
cardTextColor string Optional

Card/button text color.

contentCardColor string Optional

Card container background color.

fontFamily string Optional

Font family for the page.

fontSize string Optional

Font size. Default: md.

Known values: sm, md, lg
particles string Optional

Background particle effect. Default: none.

Known values: none, white, blue
preset string Optional

Theme preset ID.

profileAlignment string Optional

Profile section alignment. Default: center.

Known values: left, center, right
profilePictureShape string Optional

Profile picture shape. Default: circle.

Known values: circle, rounded, square
profilePictureSize string Optional

Profile picture size. Default: sm.

Known values: sm, md, lg
profileTextColor string Optional

Profile section text color.

showBranding boolean Optional

Whether Linkname branding is visible. Default: true.

socialIconsBorderColor string Optional

Border color for social icons dock/sphere.

socialIconsColor string Optional

Social icons color.

socialIconsShape string Optional

Social icons container shape. Default: dock.

Known values: dock, sphere
socialIconsShapeColor string Optional

Background color for social icons dock/sphere.

View raw schema 
{
  "type": "object",
  "properties": {
    "preset": {
      "type": "string",
      "description": "Theme preset ID."
    },
    "fontSize": {
      "type": "string",
      "description": "Font size. Default: md.",
      "knownValues": [
        "sm",
        "md",
        "lg"
      ]
    },
    "particles": {
      "type": "string",
      "description": "Background particle effect. Default: none.",
      "knownValues": [
        "none",
        "white",
        "blue"
      ]
    },
    "cardShadow": {
      "type": "string",
      "description": "Card/button shadow intensity.",
      "knownValues": [
        "none",
        "sm",
        "md",
        "lg",
        "xl"
      ]
    },
    "fontFamily": {
      "type": "string",
      "description": "Font family for the page."
    },
    "showBranding": {
      "type": "boolean",
      "description": "Whether Linkname branding is visible. Default: true."
    },
    "cardTextColor": {
      "type": "string",
      "description": "Card/button text color."
    },
    "cardHoverColor": {
      "type": "string",
      "description": "Card/button border color on hover."
    },
    "backgroundColor": {
      "type": "string",
      "description": "Page background color."
    },
    "buttonAlignment": {
      "type": "string",
      "description": "Button content alignment. Default: left.",
      "knownValues": [
        "left",
        "right"
      ]
    },
    "buttonHoverGlow": {
      "type": "boolean",
      "description": "Whether buttons glow on hover. Default: false."
    },
    "cardBorderColor": {
      "type": "string",
      "description": "Card/button border color."
    },
    "cardBorderRadius": {
      "type": "string",
      "description": "Card/button border radius.",
      "knownValues": [
        "none",
        "sm",
        "md",
        "lg",
        "full"
      ]
    },
    "contentCardColor": {
      "type": "string",
      "description": "Card container background color."
    },
    "profileAlignment": {
      "type": "string",
      "description": "Profile section alignment. Default: center.",
      "knownValues": [
        "left",
        "center",
        "right"
      ]
    },
    "profileTextColor": {
      "type": "string",
      "description": "Profile section text color."
    },
    "socialIconsColor": {
      "type": "string",
      "description": "Social icons color."
    },
    "socialIconsShape": {
      "type": "string",
      "description": "Social icons container shape. Default: dock.",
      "knownValues": [
        "dock",
        "sphere"
      ]
    },
    "backgroundGradient": {
      "type": "string",
      "description": "CSS gradient for the page background."
    },
    "profilePictureSize": {
      "type": "string",
      "description": "Profile picture size. Default: sm.",
      "knownValues": [
        "sm",
        "md",
        "lg"
      ]
    },
    "cardBackgroundColor": {
      "type": "string",
      "description": "Individual card/button background color."
    },
    "profilePictureShape": {
      "type": "string",
      "description": "Profile picture shape. Default: circle.",
      "knownValues": [
        "circle",
        "rounded",
        "square"
      ]
    },
    "buttonHoverGlowColor": {
      "type": "string",
      "description": "Color for the button hover glow effect."
    },
    "socialIconsShapeColor": {
      "type": "string",
      "description": "Background color for social icons dock/sphere."
    },
    "socialIconsBorderColor": {
      "type": "string",
      "description": "Border color for social icons dock/sphere."
    }
  },
  "description": "Theme configuration for the page appearance."
}
widgetGithub object

A GitHub contributions graph widget card.

Properties

enabled boolean Optional

Whether the widget is visible on the public page. Defaults to true.

githubUsername string Required

GitHub username.

id string Required

Unique identifier for the card.

lastSyncedAt string datetime Optional

When the contribution data was last fetched from GitHub.

size string Optional

Widget display size. Default: 1x1.

Known values: 1x1, 1x2, 2x2
totalContributions integer Optional

Total number of contributions in the last year.

type string Required

Card type discriminator.

View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "type",
    "githubUsername",
    "contributions"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the card."
    },
    "size": {
      "type": "string",
      "description": "Widget display size. Default: 1x1.",
      "knownValues": [
        "1x1",
        "1x2",
        "2x2"
      ]
    },
    "type": {
      "type": "string",
      "const": "github",
      "description": "Card type discriminator."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the widget is visible on the public page. Defaults to true."
    },
    "lastSyncedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the contribution data was last fetched from GitHub."
    },
    "contributions": {
      "type": "array",
      "items": {
        "ref": "#githubContributionDay",
        "type": "ref"
      },
      "description": "Contribution data for the last year."
    },
    "githubUsername": {
      "type": "string",
      "description": "GitHub username."
    },
    "totalContributions": {
      "type": "integer",
      "description": "Total number of contributions in the last year."
    }
  },
  "description": "A GitHub contributions graph widget card."
}
widgetGoodreads object

A Goodreads bookshelf widget card.

Properties

books array of ref#goodreadsBook Required

Books on the currently-reading shelf.

enabled boolean Optional

Whether the widget is visible on the public page. Defaults to true.

goodreadsUserId string Required

Goodreads numeric user ID.

id string Required

Unique identifier for the card.

lastSyncedAt string datetime Optional

When the book data was last fetched from Goodreads.

readBooks array of ref#goodreadsBook Optional

Books on the read shelf (used by 1x2 size).

shelf string Required

Shelf name (currently-reading, read, or to-read).

size string Optional

Widget display size. Default: 1x1.

Known values: 1x1, 1x2, 2x2
type string Required

Card type discriminator.

View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "type",
    "goodreadsUserId",
    "shelf",
    "books"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the card."
    },
    "size": {
      "type": "string",
      "description": "Widget display size. Default: 1x1.",
      "knownValues": [
        "1x1",
        "1x2",
        "2x2"
      ]
    },
    "type": {
      "type": "string",
      "const": "goodreads",
      "description": "Card type discriminator."
    },
    "books": {
      "type": "array",
      "items": {
        "ref": "#goodreadsBook",
        "type": "ref"
      },
      "description": "Books on the currently-reading shelf."
    },
    "shelf": {
      "type": "string",
      "description": "Shelf name (currently-reading, read, or to-read)."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the widget is visible on the public page. Defaults to true."
    },
    "readBooks": {
      "type": "array",
      "items": {
        "ref": "#goodreadsBook",
        "type": "ref"
      },
      "description": "Books on the read shelf (used by 1x2 size)."
    },
    "lastSyncedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the book data was last fetched from Goodreads."
    },
    "goodreadsUserId": {
      "type": "string",
      "description": "Goodreads numeric user ID."
    }
  },
  "description": "A Goodreads bookshelf widget card."
}
widgetTealfm object

A teal.fm recently played tracks widget card.

Properties

enabled boolean Optional

Whether the widget is visible on the public page. Defaults to true.

id string Required

Unique identifier for the card.

lastSyncedAt string datetime Optional

When the play data was last fetched from the PDS.

plays array of ref#tealfmPlay Required

Recently played tracks.

size string Optional

Widget display size. Default: 1x1.

Known values: 1x1, 1x2, 2x2
type string Required

Card type discriminator.

View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "type",
    "plays"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the card."
    },
    "size": {
      "type": "string",
      "description": "Widget display size. Default: 1x1.",
      "knownValues": [
        "1x1",
        "1x2",
        "2x2"
      ]
    },
    "type": {
      "type": "string",
      "const": "tealfm",
      "description": "Card type discriminator."
    },
    "plays": {
      "type": "array",
      "items": {
        "ref": "#tealfmPlay",
        "type": "ref"
      },
      "description": "Recently played tracks."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the widget is visible on the public page. Defaults to true."
    },
    "lastSyncedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the play data was last fetched from the PDS."
    }
  },
  "description": "A teal.fm recently played tracks widget card."
}

Lexicon Garden

@