social.colibri.channel.getReadCursor Documentation (EN)

main query

Returns the authenticated user's read cursor for a channel.

Parameters

channel string at-uri Required

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

Output

Encodingapplication/json

Schemalex:social.colibri.channel.defs#readCursor

Errors

AuthRequired Missing, malformed, or unverifiable service auth.

InvalidRequest A parameter or body field was missing or malformed.

NotFound The referenced record does not exist.

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 * 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": "InvalidRequest",
      "description": "A parameter or body field was missing or malformed."
    },
    {
      "name": "NotFound",
      "description": "The referenced record does not exist."
    }
  ],
  "output": {
    "schema": {
      "ref": "lex:social.colibri.channel.defs#readCursor",
      "type": "ref"
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "channel"
    ],
    "properties": {
      "channel": {
        "type": "string",
        "format": "at-uri"
      }
    }
  },
  "description": "Returns the authenticated user's read cursor for a channel."
}