InterfaceListNotificationsParams

interface ListNotificationsParams {
    accountId?: null | string;
    excludeTypes?: null | readonly (
        | "mention"
        | "status"
        | "reblog"
        | "follow"
        | "follow_request"
        | "favourite"
        | "poll"
        | "update"
        | "admin.sign_up"
        | "admin.report"
        | "severed_relationships"
        | "moderation_warning")[];
    limit?: null | number;
    maxId?: null | string;
    minId?: null | string;
    sinceId?: null | string;
    types?: null | readonly (
        | "mention"
        | "status"
        | "reblog"
        | "follow"
        | "follow_request"
        | "favourite"
        | "poll"
        | "update"
        | "admin.sign_up"
        | "admin.report"
        | "severed_relationships"
        | "moderation_warning")[];
}

Hierarchy (view full)

Properties

accountId? excludeTypes? limit? maxId? minId? sinceId? types?

Properties

Optional ReadonlyaccountId

accountId?: null | string

ID of the account

Optional ReadonlyexcludeTypes

excludeTypes?: null | readonly (
    | "mention"
    | "status"
    | "reblog"
    | "follow"
    | "follow_request"
    | "favourite"
    | "poll"
    | "update"
    | "admin.sign_up"
    | "admin.report"
    | "severed_relationships"
    | "moderation_warning")[]

Array of notifications to exclude (Allowed values: "follow", "favourite", "reblog", "mention")

Optional Readonlylimit

limit?: null | number

Maximum number of results to return per page. Defaults to 40. NOTE: Pagination is done with the Link header from the response.

Optional ReadonlymaxId

maxId?: null | string

Return results older than this ID.

Optional ReadonlyminId

minId?: null | string

Get a list of items with ID greater than this value excluding this ID

Optional ReadonlysinceId

sinceId?: null | string

Return results newer than this ID.

Optional Readonlytypes

types?: null | readonly (
    | "mention"
    | "status"
    | "reblog"
    | "follow"
    | "follow_request"
    | "favourite"
    | "poll"
    | "update"
    | "admin.sign_up"
    | "admin.report"
    | "severed_relationships"
    | "moderation_warning")[]

Instead of specifying every known type to exclude, you can specify only the types you want.

Settings

Member Visibility

On This Page

Properties