# social.colibri.community.getData

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.community.getData)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.community.getData/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.community.getData/examples)

## Definitions

### `social.colibri.community.getData`

**Type**: `query`

Returns the full state of a community: metadata, categories, channels, roles, and members.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `community` | `string` (at-uri) | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `roles` | `array` | Yes |  |
| `members` | `array` | Yes |  |
| `channels` | `array` | Yes |  |
| `community` | `ref` → `lex:social.colibri.community.defs#communityInfo` | Yes |  |
| `categories` | `array` | Yes |  |

#### Errors

- **InvalidRequest**: A parameter or body field was missing or malformed.
- **NotFound**: The referenced record does not exist.

## Raw Schema

```json
{
  "id": "social.colibri.community.getData",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "InvalidRequest",
          "description": "A parameter or body field was missing or malformed."
        },
        {
          "name": "NotFound",
          "description": "The referenced record does not exist."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "community",
            "categories",
            "channels",
            "roles",
            "members",
            "did"
          ],
          "properties": {
            "did": {
              "type": "string",
              "format": "did"
            },
            "roles": {
              "type": "array",
              "items": {
                "ref": "lex:social.colibri.community.defs#roleView",
                "type": "ref"
              }
            },
            "members": {
              "type": "array",
              "items": {
                "ref": "lex:social.colibri.community.defs#memberView",
                "type": "ref"
              }
            },
            "channels": {
              "type": "array",
              "items": {
                "ref": "lex:social.colibri.community.defs#channelView",
                "type": "ref"
              }
            },
            "community": {
              "ref": "lex:social.colibri.community.defs#communityInfo",
              "type": "ref"
            },
            "categories": {
              "type": "array",
              "items": {
                "ref": "lex:social.colibri.community.defs#categoryView",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "community"
        ],
        "properties": {
          "community": {
            "type": "string",
            "format": "at-uri"
          }
        }
      },
      "description": "Returns the full state of a community: metadata, categories, channels, roles, and members."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```