Interface AccountsResource

interface AccountsResource {
    $select(id: string): Accounts$SelectResource;
    list(
        params?: ListAccountsParams,
        meta?: HttpMetaParams<"none">,
    ): Paginator<mastodon.v1.Admin.Account[], ListAccountsParams>;
}

Index

Methods

Methods

$select

$select(id: string): Accounts$SelectResource
Parameters
- id: string
Returns Accounts$SelectResource
- Defined in src/mastodon/rest/v1/admin/accounts.ts:127

list

list(
params?: ListAccountsParams,
meta?: HttpMetaParams<"none">,
): Paginator<mastodon.v1.Admin.Account[], ListAccountsParams>
View accounts matching certain criteria for filtering, up to 100 at a time. Pagination may be done with the HTTP Link header in the response.
Parameters
- Optionalparams: ListAccountsParams
  Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Paginator<mastodon.v1.Admin.Account[], ListAccountsParams>
Array of AdminAccount

See
https://docs.joinmastodon.org/methods/admin/
- Defined in src/mastodon/rest/v1/admin/accounts.ts:136