fyi.opensocial.getGroup

lexicons.opensocial.fyi

Documentation

Get a detailed view of a group: its profile and rules, and — for a viewer who may read the members space — its roster, roles, spaces and their read gates, plus the join queue for a viewer holding `admit`. Does not require auth, but contains the viewer's standing and what their roles let them read with auth. Every gate is the decision a space credential is minted on.

main query

Get a detailed view of a group: its profile and rules, and — for a viewer who may read the members space — its roster, roles, spaces and their read gates, plus the join queue for a viewer holding `admit`. Does not require auth, but contains the viewer's standing and what their roles let them read with auth. Every gate is the decision a space credential is minted on.

Parameters

group string did Required

The group DID.

Output

Encodingapplication/json
bindings array Optional

No description available.

joinRequests array Optional

Pending requests, newest first. Present only for a viewer holding `admit`.

members array Optional

No description available.

roles array Optional

No description available.

spaces array Optional

No description available.

Errors

GroupNotFound
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
The group DID.
View raw schema 
{
  "description": "Get a detailed view of a group: its profile and rules, and — for a viewer who may read the members space — its roster, roles, spaces and their read gates, plus the join queue for a viewer holding `admit`. Does not require auth, but contains the viewer's standing and what their roles let them read with auth. 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.permissions#binding",
            "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#joinRequestView",
            "type": "ref"
          },
          "type": "array"
        },
        "members": {
          "items": {
            "ref": "fyi.opensocial.defs#memberView",
            "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"
}

Lexicon Garden

@