social.colibri.beta.notification.getUnseen Documentation (EN)

main query

Gets the requesting user's unseen notifications for one channel, used to render that channel's unread badge detail.

Parameters

channel string space-ref Required

The channel to get unseen notifications for.

limit integer Optional

Maximum number of notifications to return.

Output

Encodingapplication/json

notifications array Required

Unseen notifications raised in the given channel.

Errors

AuthRequired The request has no valid service auth.

ChannelNotFound No channel matches the given space reference.

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

channel * The channel to get unseen notifications for.

limit Maximum number of notifications to return.

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request has no valid service auth."
    },
    {
      "name": "ChannelNotFound",
      "description": "No channel matches the given space reference."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "notifications"
      ],
      "properties": {
        "notifications": {
          "type": "array",
          "items": {
            "ref": "social.colibri.beta.notification.defs#notificationView",
            "type": "ref"
          },
          "description": "Unseen notifications raised in the given channel."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "channel"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum number of notifications to return."
      },
      "channel": {
        "type": "string",
        "format": "space-ref",
        "description": "The channel to get unseen notifications for."
      }
    }
  },
  "description": "Gets the requesting user's unseen notifications for one channel, used to render that channel's unread badge detail."
}