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

main query

Gets the latest message of every text channel in a community that the requesting user may read, for channel list previews. Channels with no message the user may see are absent.

Parameters

community string did Required

The community to summarize channels of.

Output

Encodingapplication/json

summaries array Required

One summary per readable text channel that has a visible message.

Errors

AuthRequired The request has no valid service auth.

Forbidden The requesting user is not a member of this community, or is banned from it.

CommunityNotFound No community exists with that DID.

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 * The community to summarize channels of.

View raw schema

{
  "description": "Gets the latest message of every text channel in a community that the requesting user may read, for channel list previews. Channels with no message the user may see are absent.",
  "errors": [
    {
      "description": "The request has no valid service auth.",
      "name": "AuthRequired"
    },
    {
      "description": "The requesting user is not a member of this community, or is banned from it.",
      "name": "Forbidden"
    },
    {
      "description": "No community exists with that DID.",
      "name": "CommunityNotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "summaries": {
          "description": "One summary per readable text channel that has a visible message.",
          "items": {
            "ref": "social.colibri.beta.channel.defs#channelSummary",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "summaries"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "community": {
        "description": "The community to summarize channels of.",
        "format": "did",
        "type": "string"
      }
    },
    "required": [
      "community"
    ],
    "type": "params"
  },
  "type": "query"
}