masto
    Preparing search index...

    Interface Account

    Represents a user of Mastodon and their associated profile.

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

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

    Hierarchy (View Summary)

    Index

    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: string

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

    avatar: string

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

    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: boolean

    Boolean to indicate that the account performs automated actions

    createdAt: string

    When the account was created.

    discoverable?: boolean | null

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

    displayName: string

    The profile's display name.

    emojis: CustomEmoji[]

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

    fields: AccountField[]

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

    followersCount: number

    The reported followers of this profile.

    followingCount: number

    The reported follows of this profile.

    group: boolean

    Indicates that the account represents a Group actor.

    header: string

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

    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: string

    The account id

    lastStatusAt: string

    Time of the last status posted

    limited?: boolean | null

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

    locked: boolean

    Whether the account manually approves follow requests.

    memorial?: boolean | null

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

    moved?: mastodon.v1.Account | null

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

    noindex?: boolean | null

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

    note: string

    The profile's bio / description.

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

    Roles that have been granted to this account.

    statusesCount: number

    How many statuses are attached to this account.

    suspended?: boolean | null

    An extra entity returned when an account is suspended. *

    url: string

    The location of the user's profile page.

    username: string

    The username of the account, not including domain

    Settings

    Member Visibility

    On This Page

    Properties