pl-api
    Preparing search index...

    Interface GetGroupedNotificationsParams

    interface GetGroupedNotificationsParams {
        acccount_id?: string;
        exclude_types?: string[];
        expand_accounts?: "full" | "partial_avatars";
        grouped_types?: string[];
        include_filtered?: boolean;
        limit?: number;
        max_id?: string;
        min_id?: string;
        since_id?: string;
        types?: string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    acccount_id? exclude_types? expand_accounts? grouped_types? include_filtered? limit? max_id? min_id? since_id? types?

    Properties

    acccount_id?: string

    Return only notifications received from the specified account.

    exclude_types?: string[]

    Types to exclude from the results.

    expand_accounts?: "full" | "partial_avatars"

    One of full (default) or partial_avatars. When set to partial_avatars, some accounts will not be rendered in full in the returned accounts list but will be instead returned in stripped-down form in the partial_accounts list. The most recent account in a notification group is always rendered in full in the accounts attribute.

    grouped_types?: string[]

    Restrict which notification types can be grouped. Use this if there are notification types for which your client does not support grouping. If omitted, the server will group notifications of all types it supports (currently, favourite, follow and reblog). If you do not want any notification grouping, use GET /api/v1/notifications instead. Notifications that would be grouped if not for this parameter will instead be returned as individual single-notification groups with a unique group_key that can be assumed to be of the form ungrouped-{notification_id}. Please note that neither the streaming API nor the individual notification APIs are aware of this parameter and will always include a “proper” group_key that can be different from what is returned here, meaning that you may have to ignore group_key for such notifications that you do not want grouped and use ungrouped-{notification_id} instead for consistency.

    include_filtered?: boolean

    Whether to include notifications filtered by the user’s NotificationPolicy. Defaults to false.

    limit?: number

    Integer. Maximum number of results to return.

    max_id?: string

    String. All results returned will be lesser than this ID. In effect, sets an upper bound on results.

    min_id?: string

    String. Returns results immediately newer than this ID. In effect, sets a cursor at this ID and paginates forward.

    since_id?: string

    String. All results returned will be greater than this ID. In effect, sets a lower bound on results.

    types?: string[]

    Types to include in the result.

    Settings

    Member Visibility

    On This Page

    Properties