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

main query

Lists messages in a channel or in a thread, newest first by default. Messages from the repo-backed channel this one was migrated from are included and marked legacy. Messages moved in from another space are included in their move order, and messages moved out are absent.

Parameters

channel string space-ref Required

The channel or thread 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.

threads array Optional

Threads whose anchor message is in this page, so a client can draw a thread's marker under the message it was opened from without a second call. Threads the requesting user may not read are absent.

Errors

AuthRequired The request has no valid service auth.

Forbidden The requesting user may not read this channel or thread.

ChannelNotFound No channel or thread 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 or thread 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

{
  "description": "Lists messages in a channel or in a thread, newest first by default. Messages from the repo-backed channel this one was migrated from are included and marked legacy. Messages moved in from another space are included in their move order, and messages moved out are absent.",
  "errors": [
    {
      "description": "The request has no valid service auth.",
      "name": "AuthRequired"
    },
    {
      "description": "The requesting user may not read this channel or thread.",
      "name": "Forbidden"
    },
    {
      "description": "No channel or thread matches the given space reference.",
      "name": "ChannelNotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "description": "Pagination cursor for the next page.",
          "type": "string"
        },
        "messages": {
          "description": "The channel's messages.",
          "items": {
            "ref": "social.colibri.beta.channel.defs#messageView",
            "type": "ref"
          },
          "type": "array"
        },
        "threads": {
          "description": "Threads whose anchor message is in this page, so a client can draw a thread's marker under the message it was opened from without a second call. Threads the requesting user may not read are absent.",
          "items": {
            "description": "A thread.",
            "ref": "social.colibri.beta.thread.defs#threadView",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "messages"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "channel": {
        "description": "The channel or thread to list messages from.",
        "format": "space-ref",
        "type": "string"
      },
      "cursor": {
        "description": "Pagination cursor from a previous call.",
        "type": "string"
      },
      "limit": {
        "default": 50,
        "description": "Maximum number of messages to return.",
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      },
      "reverse": {
        "default": false,
        "description": "Whether to return the oldest messages first instead of the newest.",
        "type": "boolean"
      }
    },
    "required": [
      "channel"
    ],
    "type": "params"
  },
  "type": "query"
}