JSON Data Schema

To keep the URL length manageable, the JSON keys used in the data object are minified (shortened to 1-2 characters).

Schema Reference

Key Full Name Type Description
n Name String User's display name.
d Description String User's bio/about text.
i Image String URL to the profile picture.
ls Links Array List of external links objects.

Social Keys

Key Platform Value Format
f Facebook URL
t Twitter URL
ig Instagram URL
gh Github URL
tg Telegram URL
l LinkedIn URL
e Email Email Address (string)
w WhatsApp Phone Number (string)
y YouTube URL

Each item in the ls array contains:

Key Full Name Description
l Label The text displayed on the button.
i Icon The Iconify string (e.g., ph:globe-duotone).
u URL The destination URL.

Example Payload

{
  "n": "John Snow",
  "d": "I know Nothing.",
  "i": "https://example.com/avatar.jpg",
  "t": "https://twitter.com/john_snow",
  "ls": [
    {
      "l": "My Website",
      "i": "ph:globe-duotone",
      "u": "https://example.com"
    }
  ]
}