Skip to content

Profile Extension

The Profile extension adds what a User says about themselves: a bio, custom fields, and their pronouns, birthday, location and time zone. How the profile looks is in the Decorations extension.

Definition

The fields go in the pub.versia:profile key of a User’s extensions.

Extension ID
pub.versia:profile
Extends
User

Fields

Short description of the user.

fields Field[]

Custom key/value pairs. For example, links to the user’s other accounts.

key RichText Required
value RichText Required
pronouns { [key: LanguageCode]: string }

The pronouns the user uses in each language, as plain text, such as she/her or any.

LanguageCode is a BCP 47 language tag, for example en-US or fr.

birthday string

User’s birthday. MUST be an RFC 3339 full-date (YYYY-MM-DD), or --MM-DD to leave out the year, as in vCard.

location string

User’s location, as plain text, such as Paris, France. It does not need to be precise.

timezone string

User’s time zone. MUST be a name from the IANA Time Zone Database, such as America/New_York.

{
    // ...
    "type": "User",
    // ...
    "extensions": {
        "pub.versia:profile": {
            "bio": "<p>Writes about trains.</p>",
            "fields": [
                {
                    "key": "Website",
                    "value": "<a href=\"https://trains.example\">trains.example</a>"
                }
            ],
            "pronouns": {
                "en-US": "he/they",
                "fr": "il/iel"
            },
            "birthday": "--04-12",
            "location": "New York, NY",
            "timezone": "America/New_York"
        }
    }
}