fyi.opensocial.getGroup

Get a detailed view of a group: its profile and rules, and — for a viewer who may read the members space — how many are in it (listMembers names them), its roles, spaces and their read gates, plus the join queue for a viewer holding `admit`. Without auth, only the group's did and handle; with it, the viewer's standing and what their roles let them read. Every gate is the decision a space credential is minted on.

Details · query
Kindquery
Authorityopensocial.fyi
Indexed
cid bafyreidpsmual353bayiminwegynakiotyrkn4jrdga56regfrvllsh5qe

Checks

Valid Lint pass
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Get a detailed view of a group: its profile and rules, and — for a viewer who may read the members space — how many are in it (listMembers names them), its roles, spaces and their read gates, plus the join queue for a viewer holding `admit`. Without auth, only the group's did and handle; with it, the viewer's standing and what their roles let them read. Every gate is the decision a space credential is minted on.",
      "errors": [
        {
          "name": "GroupNotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "bindings": {
              "items": {
                "ref": "fyi.opensocial.defs#roleBinding",
                "type": "ref"
              },
              "type": "array"
            },
            "group": {
              "ref": "fyi.opensocial.defs#groupViewDetailed",
              "type": "ref"
            },
            "joinRequests": {
              "description": "Pending requests, newest first. Present only for a viewer holding `admit`.",
              "items": {
                "ref": "fyi.opensocial.defs#joinRequest",
                "type": "ref"
              },
              "type": "array"
            },
            "roles": {
              "items": {
                "ref": "fyi.opensocial.defs#roleView",
                "type": "ref"
              },
              "type": "array"
            },
            "spaces": {
              "items": {
                "ref": "fyi.opensocial.defs#spaceView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "group"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "group": {
            "description": "The group DID.",
            "format": "did",
            "type": "string"
          }
        },
        "required": [
          "group"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "fyi.opensocial.getGroup",
  "lexicon": 1
}