social.colibri.beta.channel.listUnreadStatus Documentation (EN)

main query

Lists per-channel unread state for the requesting user.

Parameters

community string did Optional

Restricts the results to one community. Absent returns unread state across all of the requesting user's communities.

limit integer Optional

Maximum number of statuses to return.

Output

Encodingapplication/json

statuses array Required

Unread state per channel.

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

community Restricts the results to one community. Absent returns unread state across all of the requesting user's communities.

limit Maximum number of statuses to return.

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request has no valid service auth."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "statuses"
      ],
      "properties": {
        "statuses": {
          "type": "array",
          "items": {
            "ref": "social.colibri.beta.channel.defs#unreadStatus",
            "type": "ref"
          },
          "description": "Unread state per channel."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum number of statuses to return."
      },
      "community": {
        "type": "string",
        "format": "did",
        "description": "Restricts the results to one community. Absent returns unread state across all of the requesting user's communities."
      }
    }
  },
  "description": "Lists per-channel unread state for the requesting user."
}