social.colibri.community.getData

colibri.social

Documentation

Returns the full state of a community: metadata, categories, channels, roles, and members.

main query

Returns the full state of a community: metadata, categories, channels, roles, and members.

Parameters

community string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

Output

Encodingapplication/json
categories array Required

No description available.

channels array Required

No description available.

did stringdid Required

A decentralized identifier (DID).

members array Required

No description available.

roles array Required

No description available.

Errors

InvalidRequest A parameter or body field was missing or malformed.
NotFound The referenced record does not exist.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "InvalidRequest",
      "description": "A parameter or body field was missing or malformed."
    },
    {
      "name": "NotFound",
      "description": "The referenced record does not exist."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "community",
        "categories",
        "channels",
        "roles",
        "members",
        "did"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "roles": {
          "type": "array",
          "items": {
            "ref": "lex:social.colibri.community.defs#roleView",
            "type": "ref"
          }
        },
        "members": {
          "type": "array",
          "items": {
            "ref": "lex:social.colibri.community.defs#memberView",
            "type": "ref"
          }
        },
        "channels": {
          "type": "array",
          "items": {
            "ref": "lex:social.colibri.community.defs#channelView",
            "type": "ref"
          }
        },
        "community": {
          "ref": "lex:social.colibri.community.defs#communityInfo",
          "type": "ref"
        },
        "categories": {
          "type": "array",
          "items": {
            "ref": "lex:social.colibri.community.defs#categoryView",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "community"
    ],
    "properties": {
      "community": {
        "type": "string",
        "format": "at-uri"
      }
    }
  },
  "description": "Returns the full state of a community: metadata, categories, channels, roles, and members."
}

Lexicon Garden

@