# fyi.opensocial.getGroup

> Published by [lexicons.opensocial.fyi](https://lexicon.garden/identity/did:plc:2gqnilpksz2e7faj3bwvo6qc)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.getGroup)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.getGroup/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.getGroup/examples)

## Definitions

### `fyi.opensocial.getGroup`

**Type**: `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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `group` | `string` (did) | Yes | The group DID. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `bindings` | `array` | No |  |
| `group` | `ref` → `fyi.opensocial.defs#groupViewDetailed` | Yes |  |
| `joinRequests` | `array` | No | Pending requests, newest first. Present only for a viewer holding `admit`. |
| `members` | `array` | No |  |
| `roles` | `array` | No |  |
| `spaces` | `array` | No |  |

#### Errors

- **GroupNotFound**

## Raw Schema

```json
{
  "$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 — 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"
    }
  },
  "id": "fyi.opensocial.getGroup",
  "lexicon": 1
}
```