social.colibri.beta.community.listChannels Documentation (EN)

main query

Lists a community's channels as a flat list, for clients that do not need the category grouping.

Parameters

community string did Required

The community to list channels of.

Output

Encodingapplication/json

channels array Required

The community's channels.

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.

Forbidden The requesting user lacks permission to view this community's channels.

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 list channels of.

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request is missing, malformed, or unverifiable service auth."
    },
    {
      "name": "Forbidden",
      "description": "The requesting user lacks permission to view this community's channels."
    },
    {
      "name": "CommunityNotFound",
      "description": "No community exists with that DID."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "channels"
      ],
      "properties": {
        "channels": {
          "type": "array",
          "items": {
            "ref": "social.colibri.beta.community.defs#channelView",
            "type": "ref"
          },
          "description": "The community's channels."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "community"
    ],
    "properties": {
      "community": {
        "type": "string",
        "format": "did",
        "description": "The community to list channels of."
      }
    }
  },
  "description": "Lists a community's channels as a flat list, for clients that do not need the category grouping."
}