Interface ListNotificationsParams

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 Summary)

Properties

accountId?: null | string

ID of the account

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")

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.

maxId?: null | string

Return results older than this ID.

minId?: null | string

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

sinceId?: null | string

Return results newer than this ID.

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.