# fyi.opensocial.listGroups

> 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.listGroups)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.listGroups/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.listGroups/examples)

## Definitions

### `fyi.opensocial.listGroups`

**Type**: `query`

Host-level: the groups hosted here, with their profiles. v1 discovery; a real index would come from declarations on the public network.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `groups` | `array` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Host-level: the groups hosted here, with their profiles. v1 discovery; a real index would come from declarations on the public network.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "groups": {
              "items": {
                "ref": "fyi.opensocial.defs#groupView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "groups"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {},
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "fyi.opensocial.listGroups",
  "lexicon": 1
}
```