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

main query

Gets the requesting user's notifications, newest first.

Parameters

cursor string Optional

Pagination cursor from a previous call.

limit integer Optional

Maximum number of notifications to return.

Output

Encodingapplication/json

cursor string Optional

Pagination cursor for the next page, when more notifications remain.

notifications array Required

The requesting user's notifications, newest first.

Errors

AuthRequired The request has no valid service auth.

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

cursor Pagination cursor from a previous call.

limit Maximum number of notifications to return.

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request has no valid service auth."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "notifications"
      ],
      "properties": {
        "cursor": {
          "type": "string",
          "description": "Pagination cursor for the next page, when more notifications remain."
        },
        "notifications": {
          "type": "array",
          "items": {
            "ref": "social.colibri.beta.notification.defs#notificationView",
            "type": "ref"
          },
          "description": "The requesting user's notifications, newest first."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum number of notifications to return."
      },
      "cursor": {
        "type": "string",
        "description": "Pagination cursor from a previous call."
      }
    }
  },
  "description": "Gets the requesting user's notifications, newest first."
}