Interface Account

Represents a user of Mastodon and their associated profile.

See

https://docs.joinmastodon.org/entities/account/

interface Account {
    acct: string;
    avatar: string;
    avatarStatic: string;
    bot: boolean;
    createdAt: string;
    discoverable?: null | boolean;
    displayName: string;
    emojis: CustomEmoji[];
    fields: AccountField[];
    followersCount: number;
    followingCount: number;
    group: boolean;
    header: string;
    headerStatic: string;
    id: string;
    lastStatusAt: string;
    limited?: null | boolean;
    locked: boolean;
    memorial?: null | boolean;
    moved?: null | mastodon.v1.Account;
    noindex?: null | boolean;
    note: string;
    roles: Pick<Role, "id" | "name" | "color">[];
    statusesCount: number;
    suspended?: null | boolean;
    url: string;
    username: string;
}

Hierarchy (view full)

Properties

acct avatar avatarStatic bot createdAt discoverable? displayName emojis fields followersCount followingCount group header headerStatic id lastStatusAt limited? locked memorial? moved? noindex? note roles statusesCount suspended? url username

Properties

acct

acct: string

The WebFinger account URI. Equal to username for local users, or username@domain for remote users.

avatar

avatar: string

An image icon that is shown next to statuses and in the profile.

avatarStatic

avatarStatic: string

A static version of the avatar. Equal to avatar if its value is a static image; different if avatar is an animated GIF.

bot

bot: boolean

Boolean to indicate that the account performs automated actions

createdAt

createdAt: string

When the account was created.

Optional discoverable

discoverable?: null | boolean

Whether the account has opted into discovery features such as the profile directory.

displayName

displayName: string

The profile's display name.

emojis

emojis: CustomEmoji[]

Custom emoji entities to be used when rendering the profile. If none, an empty array will be returned.

fields

fields: AccountField[]

Additional metadata attached to a profile as name-value pairs.

followersCount

followersCount: number

The reported followers of this profile.

followingCount

followingCount: number

The reported follows of this profile.

group

group: boolean

Indicates that the account represents a Group actor.

header

header: string

An image banner that is shown above the profile and in profile cards.

headerStatic

headerStatic: string

A static version of the header. Equal to header if its value is a static image; different if header is an animated GIF.

id

id: string

The account id

lastStatusAt

lastStatusAt: string

Time of the last status posted

Optional limited

limited?: null | boolean

An extra attribute returned only when an account is silenced. If true, indicates that the account should be hidden behind a warning screen.

locked

locked: boolean

Whether the account manually approves follow requests.

Optional memorial

memorial?: null | boolean

https://github.com/mastodon/mastodon/pull/23591

Optional moved

moved?: null | mastodon.v1.Account

Indicates that the profile is currently inactive and that its user has moved to a new account.

Optional noindex

noindex?: null | boolean

Whether the local user has opted out of being indexed by search engines.

note

note: string

The profile's bio / description.

roles

roles: Pick<Role, "id" | "name" | "color">[]

Roles that have been granted to this account.

statusesCount

statusesCount: number

How many statuses are attached to this account.

Optional suspended

suspended?: null | boolean

An extra entity returned when an account is suspended. *

url

url: string

The location of the user's profile page.

username

username: string

The username of the account, not including domain

Settings

Member Visibility

Theme

On This Page

acctavataravatarStaticbotcreatedAtdiscoverabledisplayNameemojisfieldsfollowersCountfollowingCountgroupheaderheaderStaticidlastStatusAtlimitedlockedmemorialmovednoindexnoterolesstatusesCountsuspendedurlusername