app.bsky.notification.getGroupedNotifications

bsky-lexicons.bsky.social

Documentation

[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.

main query

[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.

Parameters

cursor string Optional

No description available.

feed string Optional

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 integer Optional

Maximum number of groups to return.

Output

Encodingapplication/json
cursor string Optional

No description available.

groups array 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.

relatedViews array Optional

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.

seenAt stringdatetime Optional

An RFC 3339 formatted timestamp.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
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'.
Maximum number of groups to return.
View raw schema
{
  "description": "[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.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "maxLength": 1024,
          "type": "string"
        },
        "groups": {
          "description": "Notification groups or individual notifications, newest first. Clients should ignore kinds they do not recognize. Grouping behavior depends on the kind and selected feed.",
          "items": {
            "ref": "#group",
            "type": "ref"
          },
          "type": "array"
        },
        "relatedViews": {
          "description": "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.",
          "items": {
            "refs": [
              "app.bsky.actor.defs#profileViewBasic",
              "app.bsky.feed.defs#blockedPost",
              "app.bsky.feed.defs#generatorView",
              "app.bsky.feed.defs#notFoundPost",
              "app.bsky.feed.defs#postView",
              "app.bsky.graph.defs#starterPackViewBasic"
            ],
            "type": "union"
          },
          "type": "array"
        },
        "seenAt": {
          "format": "datetime",
          "type": "string"
        }
      },
      "required": [
        "groups"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "cursor": {
        "maxLength": 1024,
        "type": "string"
      },
      "feed": {
        "default": "all",
        "description": "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'.",
        "knownValues": [
          "all",
          "people-i-follow",
          "conversations",
          "followers",
          "activity"
        ],
        "maxLength": 32,
        "type": "string"
      },
      "limit": {
        "default": 30,
        "description": "Maximum number of groups to return.",
        "maximum": 50,
        "minimum": 1,
        "type": "integer"
      }
    },
    "type": "params"
  },
  "type": "query"
}
contactMatchNotification object

A contact of the requesting account joined Bluesky.

Properties

actor string did Required

A decentralized identifier (DID).

View raw schema
{
  "description": "A contact of the requesting account joined Bluesky.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    }
  },
  "required": [
    "actor"
  ],
  "type": "object"
}
followBackNotification object

An actor followed the requesting account back, possibly via a starter pack.

Properties

actor string did Required

A decentralized identifier (DID).

starterPack string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "description": "An actor followed the requesting account back, possibly via a starter pack.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    },
    "starterPack": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "actor"
  ],
  "type": "object"
}
followGroup object

Group of actors who followed the requesting account.

Properties

items array of ref#followItem Required

No description available.

minLength: 1 items
View raw schema
{
  "description": "Group of actors who followed the requesting account.",
  "properties": {
    "items": {
      "items": {
        "ref": "#followItem",
        "type": "ref"
      },
      "minLength": 1,
      "type": "array"
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}
followItem object

An actor who followed the requesting account, possibly via a starter pack.

Properties

actor string did Required

A decentralized identifier (DID).

starterPack string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "description": "An actor who followed the requesting account, possibly via a starter pack.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    },
    "starterPack": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "actor"
  ],
  "type": "object"
}
generatorLikeGroup object

Group of likes by different actors on the same feed generator.

Properties

generator string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

items array of ref#generatorLikeItem Required

No description available.

minLength: 1 items
View raw schema
{
  "description": "Group of likes by different actors on the same feed generator.",
  "properties": {
    "generator": {
      "format": "at-uri",
      "type": "string"
    },
    "items": {
      "items": {
        "ref": "#generatorLikeItem",
        "type": "ref"
      },
      "minLength": 1,
      "type": "array"
    }
  },
  "required": [
    "generator",
    "items"
  ],
  "type": "object"
}
generatorLikeItem object

One actor who liked the feed generator in the group.

Properties

actor string did Required

A decentralized identifier (DID).

View raw schema
{
  "description": "One actor who liked the feed generator in the group.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    }
  },
  "required": [
    "actor"
  ],
  "type": "object"
}
group object

Contains common metadata and kind-specific data for a notification group or individual notification.

Properties

count integer Required

No description available.

minimum: 1
id string Required

No description available.

maxLength: 256 bytes
indexedAt string datetime Required

An RFC 3339 formatted timestamp.

isRead boolean Required

No description available.

View raw schema
{
  "description": "Contains common metadata and kind-specific data for a notification group or individual notification.",
  "properties": {
    "count": {
      "minimum": 1,
      "type": "integer"
    },
    "id": {
      "maxLength": 256,
      "type": "string"
    },
    "indexedAt": {
      "format": "datetime",
      "type": "string"
    },
    "isRead": {
      "type": "boolean"
    },
    "kind": {
      "refs": [
        "#likeGroup",
        "#multiPostLikeGroup",
        "#multiPostRepostGroup",
        "#multiPostLikeViaRepostGroup",
        "#multiPostRepostViaRepostGroup",
        "#repostGroup",
        "#likeViaRepostGroup",
        "#repostViaRepostGroup",
        "#followGroup",
        "#subscribedPostGroup",
        "#generatorLikeGroup",
        "#replyNotification",
        "#quoteNotification",
        "#mentionNotification",
        "#followBackNotification",
        "#verifiedNotification",
        "#unverifiedNotification",
        "#starterPackJoinedNotification",
        "#contactMatchNotification"
      ],
      "type": "union"
    }
  },
  "required": [
    "id",
    "isRead",
    "indexedAt",
    "count",
    "kind"
  ],
  "type": "object"
}
likeGroup object

Group of likes by different actors on the same post.

Properties

items array of ref#likeItem Required

No description available.

minLength: 1 items
post string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "description": "Group of likes by different actors on the same post.",
  "properties": {
    "items": {
      "items": {
        "ref": "#likeItem",
        "type": "ref"
      },
      "minLength": 1,
      "type": "array"
    },
    "post": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "post",
    "items"
  ],
  "type": "object"
}
likeItem object

One actor who liked the group's post.

Properties

actor string did Required

A decentralized identifier (DID).

View raw schema
{
  "description": "One actor who liked the group's post.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    }
  },
  "required": [
    "actor"
  ],
  "type": "object"
}
likeViaRepostGroup object

Group of likes by different actors on the same post via the requesting account's repost.

Properties

items array of ref#likeViaRepostItem Required

No description available.

minLength: 1 items
post string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

viaRepost string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "description": "Group of likes by different actors on the same post via the requesting account's repost.",
  "properties": {
    "items": {
      "items": {
        "ref": "#likeViaRepostItem",
        "type": "ref"
      },
      "minLength": 1,
      "type": "array"
    },
    "post": {
      "format": "at-uri",
      "type": "string"
    },
    "viaRepost": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "post",
    "viaRepost",
    "items"
  ],
  "type": "object"
}
likeViaRepostItem object

One actor who liked the group's post via the requesting account's repost.

Properties

actor string did Required

A decentralized identifier (DID).

View raw schema
{
  "description": "One actor who liked the group's post via the requesting account's repost.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    }
  },
  "required": [
    "actor"
  ],
  "type": "object"
}
mentionNotification object

A post mentioning the requesting account.

Properties

parent string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

post string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "description": "A post mentioning the requesting account.",
  "properties": {
    "parent": {
      "format": "at-uri",
      "type": "string"
    },
    "post": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "post"
  ],
  "type": "object"
}
multiPostLikeGroup object

Group of likes by the same actor on different posts.

Properties

actor string did Required

A decentralized identifier (DID).

items array of ref#multiPostLikeItem Required

No description available.

minLength: 2 items
View raw schema
{
  "description": "Group of likes by the same actor on different posts.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    },
    "items": {
      "items": {
        "ref": "#multiPostLikeItem",
        "type": "ref"
      },
      "minLength": 2,
      "type": "array"
    }
  },
  "required": [
    "actor",
    "items"
  ],
  "type": "object"
}
multiPostLikeItem object

One post which was liked by the group's actor.

Properties

post string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "description": "One post which was liked by the group's actor.",
  "properties": {
    "post": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "post"
  ],
  "type": "object"
}
multiPostLikeViaRepostGroup object

Group of likes by the same actor on different posts via the requesting account's reposts.

Properties

actor string did Required

A decentralized identifier (DID).

View raw schema
{
  "description": "Group of likes by the same actor on different posts via the requesting account's reposts.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    },
    "items": {
      "items": {
        "ref": "#multiPostLikeViaRepostItem",
        "type": "ref"
      },
      "minLength": 2,
      "type": "array"
    }
  },
  "required": [
    "actor",
    "items"
  ],
  "type": "object"
}
multiPostLikeViaRepostItem object

One post which was liked by the group's actor via the requesting account's repost.

Properties

post string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

viaRepost string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "description": "One post which was liked by the group's actor via the requesting account's repost.",
  "properties": {
    "post": {
      "format": "at-uri",
      "type": "string"
    },
    "viaRepost": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "post",
    "viaRepost"
  ],
  "type": "object"
}
multiPostRepostGroup object

Group of reposts by the same actor of different posts.

Properties

actor string did Required

A decentralized identifier (DID).

View raw schema
{
  "description": "Group of reposts by the same actor of different posts.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    },
    "items": {
      "items": {
        "ref": "#multiPostRepostItem",
        "type": "ref"
      },
      "minLength": 2,
      "type": "array"
    }
  },
  "required": [
    "actor",
    "items"
  ],
  "type": "object"
}
multiPostRepostItem object

One post which was reposted by the group's actor.

Properties

post string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "description": "One post which was reposted by the group's actor.",
  "properties": {
    "post": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "post"
  ],
  "type": "object"
}
multiPostRepostViaRepostGroup object

Group of reposts by the same actor of different posts via the requesting account's reposts.

Properties

actor string did Required

A decentralized identifier (DID).

View raw schema
{
  "description": "Group of reposts by the same actor of different posts via the requesting account's reposts.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    },
    "items": {
      "items": {
        "ref": "#multiPostRepostViaRepostItem",
        "type": "ref"
      },
      "minLength": 2,
      "type": "array"
    }
  },
  "required": [
    "actor",
    "items"
  ],
  "type": "object"
}
multiPostRepostViaRepostItem object

One post which was reposted by the group's actor via the requesting account's repost.

Properties

post string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

viaRepost string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "description": "One post which was reposted by the group's actor via the requesting account's repost.",
  "properties": {
    "post": {
      "format": "at-uri",
      "type": "string"
    },
    "viaRepost": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "post",
    "viaRepost"
  ],
  "type": "object"
}
quoteNotification object

A post quoting a post by the requesting account.

Properties

parent string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

post string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "description": "A post quoting a post by the requesting account.",
  "properties": {
    "parent": {
      "format": "at-uri",
      "type": "string"
    },
    "post": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "post"
  ],
  "type": "object"
}
replyNotification object

A reply to a post by the requesting account or to a thread they are participating in.

Properties

parent string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

post string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "description": "A reply to a post by the requesting account or to a thread they are participating in.",
  "properties": {
    "parent": {
      "format": "at-uri",
      "type": "string"
    },
    "post": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "post",
    "parent"
  ],
  "type": "object"
}
repostGroup object

Group of reposts by different actors of the same post.

Properties

items array of ref#repostItem Required

No description available.

minLength: 1 items
post string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "description": "Group of reposts by different actors of the same post.",
  "properties": {
    "items": {
      "items": {
        "ref": "#repostItem",
        "type": "ref"
      },
      "minLength": 1,
      "type": "array"
    },
    "post": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "post",
    "items"
  ],
  "type": "object"
}
repostItem object

One actor who reposted the group's post.

Properties

actor string did Required

A decentralized identifier (DID).

View raw schema
{
  "description": "One actor who reposted the group's post.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    }
  },
  "required": [
    "actor"
  ],
  "type": "object"
}
repostViaRepostGroup object

Group of reposts by different actors of the same post via the requesting account's repost.

Properties

post string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

viaRepost string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "description": "Group of reposts by different actors of the same post via the requesting account's repost.",
  "properties": {
    "items": {
      "items": {
        "ref": "#repostViaRepostItem",
        "type": "ref"
      },
      "minLength": 1,
      "type": "array"
    },
    "post": {
      "format": "at-uri",
      "type": "string"
    },
    "viaRepost": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "post",
    "viaRepost",
    "items"
  ],
  "type": "object"
}
repostViaRepostItem object

One actor who reposted the group's post via the requesting account's repost.

Properties

actor string did Required

A decentralized identifier (DID).

View raw schema
{
  "description": "One actor who reposted the group's post via the requesting account's repost.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    }
  },
  "required": [
    "actor"
  ],
  "type": "object"
}
starterPackJoinedNotification object

An actor joined Bluesky via a starter pack created by the requesting account.

Properties

actor string did Required

A decentralized identifier (DID).

starterPack string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "description": "An actor joined Bluesky via a starter pack created by the requesting account.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    },
    "starterPack": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "actor",
    "starterPack"
  ],
  "type": "object"
}
subscribedPostGroup object

Group of new posts by actors the requesting account subscribes to.

Properties

View raw schema
{
  "description": "Group of new posts by actors the requesting account subscribes to.",
  "properties": {
    "items": {
      "items": {
        "ref": "#subscribedPostItem",
        "type": "ref"
      },
      "minLength": 1,
      "type": "array"
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}
subscribedPostItem object

One new post by an actor the requesting account subscribes to.

Properties

actor string did Required

A decentralized identifier (DID).

post string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "description": "One new post by an actor the requesting account subscribes to.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    },
    "post": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "actor",
    "post"
  ],
  "type": "object"
}
unverifiedNotification object

A verification of the requesting account was removed.

Properties

actor string did Required

A decentralized identifier (DID).

View raw schema
{
  "description": "A verification of the requesting account was removed.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    }
  },
  "required": [
    "actor"
  ],
  "type": "object"
}
verifiedNotification object

An actor verified the requesting account.

Properties

actor string did Required

A decentralized identifier (DID).

View raw schema
{
  "description": "An actor verified the requesting account.",
  "properties": {
    "actor": {
      "format": "did",
      "type": "string"
    }
  },
  "required": [
    "actor"
  ],
  "type": "object"
}

Lexicon Garden

@