app.bsky.notification.getGroupedNotifications

[UNSTABLE - DO NOT USE THIS ENDPOINT WHILE THIS NOTE IS HERE] Enumerate notifications for the requesting account, pre-grouped for rendering. Supersedes listNotifications. Requires auth.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.Params

Bases: ParamsModelBase

Parameters model for app.bsky.notification.getGroupedNotifications.

field cursor: str | None = None

Cursor.

Constraints:
  • max_length = 1024

field feed: Literal['all', 'people-i-follow', 'conversations', 'followers', 'activity'] | str | None = None
Constraints:
  • max_length = 32

field limit: int | None = None

Maximum number of groups to return.

Constraints:
  • ge = 1

  • le = 50

class atproto_client.models.app.bsky.notification.get_grouped_notifications.ParamsDict

Bases: TypedDict

cursor: NotRequired[str | None]

Cursor.

feed: NotRequired[Literal['all', 'people-i-follow', 'conversations', 'followers', 'activity'] | str | None]

Which notification feed to return. Grouping behavior varies by feed: notifications about follows might be grouped in ‘all’ and ungrouped (or rather, in single-item groups) in ‘followers’.

limit: NotRequired[int | None]

Maximum number of groups to return.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.Response

Bases: ResponseModelBase

Output data model for app.bsky.notification.getGroupedNotifications.

field cursor: str | None = None

Cursor.

Constraints:
  • max_length = 1024

field groups: List[models.AppBskyNotificationGetGroupedNotifications.Group] [Required]

Notification groups or individual notifications, newest first. Clients should ignore kinds they do not recognize. Grouping behavior depends on the kind and selected feed.

field related_views: List[models.AppBskyActorDefs.ProfileViewBasic | models.AppBskyFeedDefs.BlockedPost | models.AppBskyFeedDefs.GeneratorView | models.AppBskyFeedDefs.NotFoundPost | models.AppBskyFeedDefs.PostView | models.AppBskyGraphDefs.StarterPackViewBasic | DotDict] | None = None

Reusable views referenced by notifications. Views shared across notifications appear once to avoid duplication. Each group contributes only its first 10 of each related view to this array. Ex: for a group containing likes in a post, we might have a large number of likeItem (e.g., 50) in a group, but only the profile views for the newest 10 items will be included here.

field seen_at: DateTime | None = None

Seen at.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.Group

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. Contains common metadata and kind-specific data for a notification group or individual notification.

field count: int [Required]

Count.

Constraints:
  • ge = 1

field id: str [Required]

Id.

Constraints:
  • max_length = 256

field indexed_at: DateTime [Required]

Indexed at.

field is_read: bool [Required]

Is read.

field kind: models.AppBskyNotificationGetGroupedNotifications.LikeGroup | models.AppBskyNotificationGetGroupedNotifications.MultiPostLikeGroup | models.AppBskyNotificationGetGroupedNotifications.MultiPostRepostGroup | models.AppBskyNotificationGetGroupedNotifications.MultiPostLikeViaRepostGroup | models.AppBskyNotificationGetGroupedNotifications.MultiPostRepostViaRepostGroup | models.AppBskyNotificationGetGroupedNotifications.RepostGroup | models.AppBskyNotificationGetGroupedNotifications.LikeViaRepostGroup | models.AppBskyNotificationGetGroupedNotifications.RepostViaRepostGroup | models.AppBskyNotificationGetGroupedNotifications.FollowGroup | models.AppBskyNotificationGetGroupedNotifications.SubscribedPostGroup | models.AppBskyNotificationGetGroupedNotifications.GeneratorLikeGroup | models.AppBskyNotificationGetGroupedNotifications.ReplyNotification | models.AppBskyNotificationGetGroupedNotifications.QuoteNotification | models.AppBskyNotificationGetGroupedNotifications.MentionNotification | models.AppBskyNotificationGetGroupedNotifications.FollowBackNotification | models.AppBskyNotificationGetGroupedNotifications.VerifiedNotification | models.AppBskyNotificationGetGroupedNotifications.UnverifiedNotification | models.AppBskyNotificationGetGroupedNotifications.StarterPackJoinedNotification | models.AppBskyNotificationGetGroupedNotifications.ContactMatchNotification | DotDict [Required]

Kind.

Constraints:
  • __module__ = atproto_client.models.unknown_union

  • __firstlineno__ = 17

  • __doc__ = Annotation for open ref unions: an unrecognized $type falls back to DotDict. Applied to t.Union[<known members>, 'dot_dict.DotDictType']. Members are discriminated by py_type as usual, so a known type that fails validation still raises. Only a $type that matches no member, or a missing one, degrades to a DotDict.

  • __get_pydantic_core_schema__ = <bound method UnknownUnionFallback.__get_pydantic_core_schema__ of <class ‘atproto_client.models.unknown_union.UnknownUnionFallback’>>

  • __static_attributes__ = ()

  • __dict__ = {‘__module__’: ‘atproto_client.models.unknown_union’, ‘__firstlineno__’: 17, ‘__doc__’: “Annotation for open ref unions: an unrecognized $type falls back to DotDict.nnApplied to t.Union[<known members>, 'dot_dict.DotDictType']. Members are discriminated byn``py_type`` as usual, so a known type that fails validation still raises. Only a $type thatnmatches no member, or a missing one, degrades to a DotDict.n”, ‘__get_pydantic_core_schema__’: <classmethod(<function UnknownUnionFallback.__get_pydantic_core_schema__ at 0x7bc6f7b3ccc0>)>, ‘__static_attributes__’: (), ‘__dict__’: <attribute ‘__dict__’ of ‘UnknownUnionFallback’ objects>, ‘__weakref__’: <attribute ‘__weakref__’ of ‘UnknownUnionFallback’ objects>}

  • __weakref__ = <attribute ‘__weakref__’ of ‘UnknownUnionFallback’ objects>

class atproto_client.models.app.bsky.notification.get_grouped_notifications.LikeGroup

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. Group of likes by different actors on the same post.

field items: List[models.AppBskyNotificationGetGroupedNotifications.LikeItem] [Required]

Items.

Constraints:
  • min_length = 1

field post: AtUri [Required]

Post.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.LikeItem

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. One actor who liked the group’s post.

field actor: Did [Required]

Actor.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.MultiPostLikeGroup

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. Group of likes by the same actor on different posts.

field actor: Did [Required]

Actor.

field items: List[models.AppBskyNotificationGetGroupedNotifications.MultiPostLikeItem] [Required]

Items.

Constraints:
  • min_length = 2

class atproto_client.models.app.bsky.notification.get_grouped_notifications.MultiPostLikeItem

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. One post which was liked by the group’s actor.

field post: AtUri [Required]

Post.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.MultiPostRepostGroup

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. Group of reposts by the same actor of different posts.

field actor: Did [Required]

Actor.

field items: List[models.AppBskyNotificationGetGroupedNotifications.MultiPostRepostItem] [Required]

Items.

Constraints:
  • min_length = 2

class atproto_client.models.app.bsky.notification.get_grouped_notifications.MultiPostRepostItem

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. One post which was reposted by the group’s actor.

field post: AtUri [Required]

Post.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.MultiPostLikeViaRepostGroup

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. Group of likes by the same actor on different posts via the requesting account’s reposts.

field actor: Did [Required]

Actor.

field items: List[models.AppBskyNotificationGetGroupedNotifications.MultiPostLikeViaRepostItem] [Required]

Items.

Constraints:
  • min_length = 2

class atproto_client.models.app.bsky.notification.get_grouped_notifications.MultiPostLikeViaRepostItem

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. One post which was liked by the group’s actor via the requesting account’s repost.

field post: AtUri [Required]

Post.

field via_repost: AtUri [Required]

Via repost.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.MultiPostRepostViaRepostGroup

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. Group of reposts by the same actor of different posts via the requesting account’s reposts.

field actor: Did [Required]

Actor.

field items: List[models.AppBskyNotificationGetGroupedNotifications.MultiPostRepostViaRepostItem] [Required]

Items.

Constraints:
  • min_length = 2

class atproto_client.models.app.bsky.notification.get_grouped_notifications.MultiPostRepostViaRepostItem

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. One post which was reposted by the group’s actor via the requesting account’s repost.

field post: AtUri [Required]

Post.

field via_repost: AtUri [Required]

Via repost.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.RepostGroup

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. Group of reposts by different actors of the same post.

field items: List[models.AppBskyNotificationGetGroupedNotifications.RepostItem] [Required]

Items.

Constraints:
  • min_length = 1

field post: AtUri [Required]

Post.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.RepostItem

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. One actor who reposted the group’s post.

field actor: Did [Required]

Actor.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.LikeViaRepostGroup

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. Group of likes by different actors on the same post via the requesting account’s repost.

field items: List[models.AppBskyNotificationGetGroupedNotifications.LikeViaRepostItem] [Required]

Items.

Constraints:
  • min_length = 1

field post: AtUri [Required]

Post.

field via_repost: AtUri [Required]

Via repost.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.LikeViaRepostItem

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. One actor who liked the group’s post via the requesting account’s repost.

field actor: Did [Required]

Actor.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.RepostViaRepostGroup

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. Group of reposts by different actors of the same post via the requesting account’s repost.

field items: List[models.AppBskyNotificationGetGroupedNotifications.RepostViaRepostItem] [Required]

Items.

Constraints:
  • min_length = 1

field post: AtUri [Required]

Post.

field via_repost: AtUri [Required]

Via repost.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.RepostViaRepostItem

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. One actor who reposted the group’s post via the requesting account’s repost.

field actor: Did [Required]

Actor.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.FollowGroup

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. Group of actors who followed the requesting account.

field items: List[models.AppBskyNotificationGetGroupedNotifications.FollowItem] [Required]

Items.

Constraints:
  • min_length = 1

class atproto_client.models.app.bsky.notification.get_grouped_notifications.FollowItem

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. An actor who followed the requesting account, possibly via a starter pack.

field actor: Did [Required]

Actor.

field starter_pack: AtUri | None = None

Starter pack.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.SubscribedPostGroup

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. Group of new posts by actors the requesting account subscribes to.

field items: List[models.AppBskyNotificationGetGroupedNotifications.SubscribedPostItem] [Required]

Items.

Constraints:
  • min_length = 1

class atproto_client.models.app.bsky.notification.get_grouped_notifications.SubscribedPostItem

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. One new post by an actor the requesting account subscribes to.

field actor: Did [Required]

Actor.

field post: AtUri [Required]

Post.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.GeneratorLikeGroup

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. Group of likes by different actors on the same feed generator.

field generator: AtUri [Required]

Generator.

field items: List[models.AppBskyNotificationGetGroupedNotifications.GeneratorLikeItem] [Required]

Items.

Constraints:
  • min_length = 1

class atproto_client.models.app.bsky.notification.get_grouped_notifications.GeneratorLikeItem

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. One actor who liked the feed generator in the group.

field actor: Did [Required]

Actor.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.ReplyNotification

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. A reply to a post by the requesting account or to a thread they are participating in.

field parent: AtUri [Required]

Parent.

field post: AtUri [Required]

Post.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.QuoteNotification

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. A post quoting a post by the requesting account.

field parent: AtUri | None = None

Parent.

field post: AtUri [Required]

Post.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.MentionNotification

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. A post mentioning the requesting account.

field parent: AtUri | None = None

Parent.

field post: AtUri [Required]

Post.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.FollowBackNotification

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. An actor followed the requesting account back, possibly via a starter pack.

field actor: Did [Required]

Actor.

field starter_pack: AtUri | None = None

Starter pack.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.VerifiedNotification

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. An actor verified the requesting account.

field actor: Did [Required]

Actor.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.UnverifiedNotification

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. A verification of the requesting account was removed.

field actor: Did [Required]

Actor.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.StarterPackJoinedNotification

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. An actor joined Bluesky via a starter pack created by the requesting account.

field actor: Did [Required]

Actor.

field starter_pack: AtUri [Required]

Starter pack.

class atproto_client.models.app.bsky.notification.get_grouped_notifications.ContactMatchNotification

Bases: ModelBase

Definition model for app.bsky.notification.getGroupedNotifications. A contact of the requesting account joined Bluesky.

field actor: Did [Required]

Actor.