social.colibri.channel.listUnreadStatus Documentation (EN)

main query

Lists the unread status of every channel in a community for the authenticated user.

Parameters

community string at-uri Required

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

Output

Encodingapplication/json

channels array Required

No description available.

Errors

AuthRequired Missing, malformed, or unverifiable service auth.

Forbidden The caller lacks the permission this method requires.

InvalidRequest A parameter or body field was missing or malformed.

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 * An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AuthRequired",
      "description": "Missing, malformed, or unverifiable service auth."
    },
    {
      "name": "Forbidden",
      "description": "The caller lacks the permission this method requires."
    },
    {
      "name": "InvalidRequest",
      "description": "A parameter or body field was missing or malformed."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "channels"
      ],
      "properties": {
        "channels": {
          "type": "array",
          "items": {
            "ref": "lex:social.colibri.channel.defs#unreadStatus",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "community"
    ],
    "properties": {
      "community": {
        "type": "string",
        "format": "at-uri"
      }
    }
  },
  "description": "Lists the unread status of every channel in a community for the authenticated user."
}