fyi.opensocial.getSite Documentation (EN)

main query

The group's site record, to change and put back with putSite. A group that has not published one gets the starter, with no uri. Public: nothing in a site is private.

Parameters

group string did Required

A decentralized identifier (DID).

Output

Encodingapplication/json

cid stringcid Optional

A content identifier (CID) referencing immutable data.

site unknown Required

A fyi.opensocial.site record.

uri stringat-uri Optional

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

Errors

NotFound

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

group * A decentralized identifier (DID).

View raw schema

{
  "description": "The group's site record, to change and put back with putSite. A group that has not published one gets the starter, with no uri. Public: nothing in a site is private.",
  "errors": [
    {
      "name": "NotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cid": {
          "format": "cid",
          "type": "string"
        },
        "site": {
          "description": "A fyi.opensocial.site record.",
          "type": "unknown"
        },
        "uri": {
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "site"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "group": {
        "format": "did",
        "type": "string"
      }
    },
    "required": [
      "group"
    ],
    "type": "params"
  },
  "type": "query"
}