Skip to content

Preferences

The authenticated user’s preferences.

object
locale
required

The UI locale, a BCP 47 language tag.

string
locale_follows_browser
required

Whether clients with a browser show its language instead of locale, or the server’s default language when the browser names none they have. They keep locale at what they last detected, for what has no browser (email, push). True for a new user.

boolean
time_zone
required

The time zone, an IANA name such as Asia/Tokyo; UTC until one is chosen.

string
time_zone_chosen
required

Whether a time zone has been chosen: false for a new user until a request sets time_zone. Clients may then set it to the device’s time zone.

boolean
time_zone_follows_browser
required

Whether clients with a browser show dates in its time zone instead of time_zone. They keep time_zone at what they last detected, for what has no browser. True for a new user.

boolean
default_visibility
required

Who may see a status: public everyone, listed on public timelines; local logged-in users of this instance and followers; unlisted everyone, kept off public timelines; private followers and mentioned accounts; direct mentioned accounts.

string
Allowed values: public local unlisted private direct
default_interaction_policy
required

Who may reply to, boost, and quote the user’s new statuses, for the kinds their interaction_policy leaves out. Everyone at once for a new user.

Schema: InteractionPolicy

object
default_post_language
required

The language of new posts that name none, a BCP 47 language tag; und when undetermined.

string
require_media_description
required

Whether clients ask for a description before posting media without one.

boolean
email_suppression

Whether emails no longer reach the primary address, read-only; omitted when they do. After a hard_bounce, the user asks for the verification email again (POST /accounts/email/verification) to show that the address works.

Schema: EmailSuppression

object
timeline_auto_insert
required

Whether the web client inserts new timeline posts without asking, instead of offering them behind a “show new posts” button. On for a new user; the same on every device.

boolean
link_card_size
required

How the web client shows link cards: large, with the image above the text, or small, with a square image beside it. large for a new user; the same on every device.

string
Allowed values: large small
timeline_languages
required

The languages that timelines show, sorted; empty shows every language.

Array<string>

Example generated

{
"locale": "example",
"locale_follows_browser": true,
"time_zone": "example",
"time_zone_chosen": true,
"time_zone_follows_browser": true,
"default_visibility": "public",
"default_interaction_policy": {},
"default_post_language": "example",
"require_media_description": true,
"timeline_auto_insert": true,
"link_card_size": "large",
"timeline_languages": [
"example"
]
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site