Interface AccountsResource

familiarFollowers

relationships

search

$select

• $select(id: string): Accounts$SelectResource

  Parameters

  • id: string

  Returns Accounts$SelectResource

create

• create(
      params: CreateAccountParams,
      meta?: HttpMetaParams<"multipart-form">,
  ): Promise<Token>

  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

  • params: CreateAccountParams

    Parameters
  • Optionalmeta: HttpMetaParams<"multipart-form">

  Returns Promise<Token>

  Token

  See

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

fetch

• fetch(
      params: FetchAccountsParams,
      meta?: HttpMetaParams<"none">,
  ): Promise<mastodon.v1.Account[]>

  Parameters

  • params: FetchAccountsParams
  • Optionalmeta: HttpMetaParams<"none">

  Returns Promise<mastodon.v1.Account[]>

lookup

• lookup(
      params: LookupAccountParams,
      meta?: HttpMetaParams<"none">,
  ): Promise<mastodon.v1.Account>

  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

  • params: LookupAccountParams

    Parameters
  • Optionalmeta: HttpMetaParams<"none">

  Returns Promise<mastodon.v1.Account>

  Account

updateCredentials

• updateCredentials(
      params: UpdateCredentialsParams,
      meta?: HttpMetaParams<"multipart-form">,
  ): Promise<AccountCredentials>

  Update the user's display and preferences.

  Parameters

  • params: UpdateCredentialsParams

    Parameters
  • Optionalmeta: HttpMetaParams<"multipart-form">

  Returns Promise<AccountCredentials>

  the user's own Account with Source

  See

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

verifyCredentials

• verifyCredentials(meta?: HttpMetaParams<"none">): Promise<AccountCredentials>

  Test to make sure that the user token works.

  Parameters

  • Optionalmeta: HttpMetaParams<"none">

  Returns Promise<AccountCredentials>

  the user's own Account with Source

  See

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