com.getorbyt.community.getCommunity

A single Community by AT-URI or by name, hydrated with viewer state when the request is authenticated. Exactly one of `community` and `name` is required: the AT-URI is the Community's identity, while the name is what a public link can carry.

Repository @getorbyt.com did:plc:2xrqztnmzlckb3xfuuukupso namespace authority
Details · query
Kindquery
Authoritycommunity.getorbyt.com
Indexed
cid bafyreigeoghoq7lxxqsx4y5ol6pvtra7elai5ioywxcaozxczm4oarlb34

Checks

Valid Lint pass
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "A single Community by AT-URI or by name, hydrated with viewer state when the request is authenticated. Exactly one of `community` and `name` is required: the AT-URI is the Community's identity, while the name is what a public link can carry.",
      "errors": [
        {
          "name": "CommunityNotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "community": {
              "ref": "com.getorbyt.community.defs#view",
              "type": "ref"
            }
          },
          "required": [
            "community"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "community": {
            "format": "at-uri",
            "type": "string"
          },
          "name": {
            "description": "The Community's globally unique lowercase name, as it appears in a shared link.",
            "maxLength": 63,
            "minLength": 2,
            "type": "string"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "com.getorbyt.community.getCommunity",
  "lexicon": 1
}