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

main query

Gets the community's category layout, each category with its channels already nested. This is what a client needs to draw the sidebar in one call.

Parameters

community string did Required

The community to list categories of.

Output

Encodingapplication/json

categories array Required

The community's categories, in display order.

Errors

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

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

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 categories 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 categories."
    },
    {
      "name": "CommunityNotFound",
      "description": "No community exists with that DID."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "categories"
      ],
      "properties": {
        "categories": {
          "type": "array",
          "items": {
            "ref": "social.colibri.beta.community.defs#categoryView",
            "type": "ref"
          },
          "description": "The community's categories, in display order."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "community"
    ],
    "properties": {
      "community": {
        "type": "string",
        "format": "did",
        "description": "The community to list categories of."
      }
    }
  },
  "description": "Gets the community's category layout, each category with its channels already nested. This is what a client needs to draw the sidebar in one call."
}