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

main query

Lists messages in a channel, newest first by default. Messages from the repo-backed channel this one was migrated from are included and marked legacy.

Parameters

channel string space-ref Required

The channel to list messages from.

cursor string Optional

Pagination cursor from a previous call.

limit integer Optional

Maximum number of messages to return.

reverse boolean Optional

Whether to return the oldest messages first instead of the newest.

Output

Encodingapplication/json

cursor string Optional

Pagination cursor for the next page.

messages array Required

The channel's messages.

Errors

AuthRequired The request has no valid service auth.

Forbidden The requesting user may not read this channel.

ChannelNotFound No channel matches the given space reference.

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 * The channel to list messages from.

cursor Pagination cursor from a previous call.

limit Maximum number of messages to return.

reverse Whether to return the oldest messages first instead of the newest.

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request has no valid service auth."
    },
    {
      "name": "Forbidden",
      "description": "The requesting user may not read this channel."
    },
    {
      "name": "ChannelNotFound",
      "description": "No channel matches the given space reference."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "messages"
      ],
      "properties": {
        "cursor": {
          "type": "string",
          "description": "Pagination cursor for the next page."
        },
        "messages": {
          "type": "array",
          "items": {
            "ref": "social.colibri.beta.channel.defs#messageView",
            "type": "ref"
          },
          "description": "The channel's messages."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "channel"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum number of messages to return."
      },
      "cursor": {
        "type": "string",
        "description": "Pagination cursor from a previous call."
      },
      "channel": {
        "type": "string",
        "format": "space-ref",
        "description": "The channel to list messages from."
      },
      "reverse": {
        "type": "boolean",
        "default": false,
        "description": "Whether to return the oldest messages first instead of the newest."
      }
    }
  },
  "description": "Lists messages in a channel, newest first by default. Messages from the repo-backed channel this one was migrated from are included and marked legacy."
}