app.bsky.notification.listNotifications

bsky-lexicons.bsky.social

Documentation

Enumerate notifications for the requesting account. Requires auth.

main query

Enumerate notifications for the requesting account. Requires auth.

Parameters

cursor string Optional

No description available.

limit integer Optional

No description available.

priority boolean Optional

Deprecated: this parameter is ignored.

reasons array of string Optional

Notification reasons to include in response.

seenAt string datetime Optional

Deprecated: this parameter is unsupported and will cause an error.

Output

Encodingapplication/json
cursor string Optional

No description available.

notifications array Required

No description available.

priority boolean Optional

Deprecated: this field is no longer populated.

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
Deprecated: this parameter is ignored.
Notification reasons to include in response.
Deprecated: this parameter is unsupported and will cause an error.
View raw schema 
{
  "description": "Enumerate notifications for the requesting account. Requires auth.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "type": "string"
        },
        "notifications": {
          "items": {
            "ref": "#notification",
            "type": "ref"
          },
          "type": "array"
        },
        "priority": {
          "description": "Deprecated: this field is no longer populated.",
          "type": "boolean"
        },
        "seenAt": {
          "format": "datetime",
          "type": "string"
        }
      },
      "required": [
        "notifications"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "cursor": {
        "type": "string"
      },
      "limit": {
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      },
      "priority": {
        "description": "Deprecated: this parameter is ignored.",
        "type": "boolean"
      },
      "reasons": {
        "description": "Notification reasons to include in response.",
        "items": {
          "description": "A reason that matches the reason property of #notification.",
          "type": "string"
        },
        "type": "array"
      },
      "seenAt": {
        "description": "Deprecated: this parameter is unsupported and will cause an error.",
        "format": "datetime",
        "type": "string"
      }
    },
    "type": "params"
  },
  "type": "query"
}
notification object

No description available.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

isRead boolean Required

No description available.

reason string Required

The reason why this notification was delivered - e.g. your post was liked, or you received a new follower.

Known values: like, repost, follow, mention, reply, quote, starterpack-joined, verified, unverified, like-via-repost, repost-via-repost, subscribed-post, contact-match
reasonSubject string at-uri Optional

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

record unknown Required

No description available.

uri string at-uri Required

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

View raw schema 
{
  "properties": {
    "author": {
      "ref": "app.bsky.actor.defs#profileView",
      "type": "ref"
    },
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "indexedAt": {
      "format": "datetime",
      "type": "string"
    },
    "isRead": {
      "type": "boolean"
    },
    "labels": {
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "reason": {
      "description": "The reason why this notification was delivered - e.g. your post was liked, or you received a new follower.",
      "knownValues": [
        "like",
        "repost",
        "follow",
        "mention",
        "reply",
        "quote",
        "starterpack-joined",
        "verified",
        "unverified",
        "like-via-repost",
        "repost-via-repost",
        "subscribed-post",
        "contact-match"
      ],
      "type": "string"
    },
    "reasonSubject": {
      "format": "at-uri",
      "type": "string"
    },
    "record": {
      "type": "unknown"
    },
    "starterPack": {
      "description": "The starter pack associated with this notification. Present when the notification is for a follow originating from a starter pack.",
      "ref": "app.bsky.graph.defs#starterPackViewBasic",
      "type": "ref"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "cid",
    "author",
    "reason",
    "record",
    "isRead",
    "indexedAt"
  ],
  "type": "object"
}

Lexicon Garden

@