masto
    Preparing search index...

    Interface AccountsResource

    interface AccountsResource {
        create: Method<
            Token,
            CreateAccountParams,
            HttpMetaParams<"multipart-form">,
        >;
        familiarFollowers: AccountsFamiliarFollowersResource;
        fetch: Method<mastodon.v1.Account[], FetchAccountsParams>;
        lookup: Method<mastodon.v1.Account, LookupAccountParams>;
        relationships: AccountsRelationshipsResource;
        search: AccountsSearchResource;
        updateCredentials: Method<
            AccountCredentials,
            UpdateCredentialsParams,
            HttpMetaParams<"multipart-form">,
        >;
        verifyCredentials: Method<AccountCredentials>;
        $select(id: string): mastodon.rest.v1.Accounts$SelectResource;
    }
    Index

    Properties

    create familiarFollowers fetch lookup relationships search updateCredentials verifyCredentials

    Methods

    $select

    Properties

    create: Method<Token, CreateAccountParams, HttpMetaParams<"multipart-form">>

    Creates a user and account records. Returns an account access token for the app that initiated the request. The app should save this token for later, and should wait for the user to confirm their account by clicking a link in their email inbox.

    Parameters

    Token

    https://docs.joinmastodon.org/methods/accounts/#create

    familiarFollowers: AccountsFamiliarFollowersResource
    fetch: Method<mastodon.v1.Account[], FetchAccountsParams>
    lookup: Method<mastodon.v1.Account, LookupAccountParams>

    This method allows to quickly convert a username of a known account to an ID that can be used with the REST API, or to check if a username is available for sign-up

    Parameters

    Account

    relationships: AccountsRelationshipsResource
    search: AccountsSearchResource
    updateCredentials: Method<
        AccountCredentials,
        UpdateCredentialsParams,
        HttpMetaParams<"multipart-form">,
    >

    Update the user's display and preferences.

    Parameters

    the user's own Account with Source

    https://docs.joinmastodon.org/methods/accounts/

    verifyCredentials: Method<AccountCredentials>

    Test to make sure that the user token works.

    the user's own Account with Source

    https://docs.joinmastodon.org/methods/accounts/

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods