social.colibri.channel.getChannelView

colibri.social

Documentation

Returns the initial view of a channel: recent messages, the read cursor, and unseen notifications.

main query

Returns the initial view of a channel: recent messages, the read cursor, and unseen notifications.

Parameters

channel string at-uri Required

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

limit integer Optional

No description available.

Output

Encodingapplication/json
cursor string Optional

No description available.

messages array Required

No description available.

unseen array Required

No description available.

Errors

AuthRequired Missing, malformed, or unverifiable service auth.
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.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).
View raw schema 
{
  "description": "Returns the initial view of a channel: recent messages, the read cursor, and unseen notifications.",
  "errors": [
    {
      "description": "Missing, malformed, or unverifiable service auth.",
      "name": "AuthRequired"
    },
    {
      "description": "A parameter or body field was missing or malformed.",
      "name": "InvalidRequest"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "type": "string"
        },
        "messages": {
          "items": {
            "ref": "lex:social.colibri.channel.defs#message",
            "type": "ref"
          },
          "type": "array"
        },
        "readCursor": {
          "ref": "lex:social.colibri.channel.defs#readCursor",
          "type": "ref"
        },
        "unseen": {
          "items": {
            "ref": "lex:social.colibri.notification.defs#unseenNotification",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "messages",
        "unseen"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "channel": {
        "format": "at-uri",
        "type": "string"
      },
      "limit": {
        "type": "integer"
      }
    },
    "required": [
      "channel"
    ],
    "type": "params"
  },
  "type": "query"
}

Lexicon Garden

@