com.getorbyt.community.getCommunity

getorbyt.com

Documentation

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.

main query

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.

Parameters

community string at-uri Optional

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

name string Optional

The Community's globally unique lowercase name, as it appears in a shared link.

Output

Encodingapplication/json

Errors

CommunityNotFound
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).
The Community's globally unique lowercase name, as it appears in a shared link.
View raw schema 
{
  "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"
}

Lexicon Garden

@