# blue.catbird.circle.getCapabilities

> Published by [catbird.blue](https://lexicon.garden/identity/did:plc:xg4h4n7w5mh3m4uoi27me4hh)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:xg4h4n7w5mh3m4uoi27me4hh/blue.catbird.circle.getCapabilities)
- [Documentation](https://lexicon.garden/lexicon/did:plc:xg4h4n7w5mh3m4uoi27me4hh/blue.catbird.circle.getCapabilities/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:xg4h4n7w5mh3m4uoi27me4hh/blue.catbird.circle.getCapabilities/examples)

## Definitions

### `blue.catbird.circle.getCapabilities`

**Type**: `query`

Get capability metadata for Catbird Circles support

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `enabled` | `boolean` | Yes |  |
| `supportsImages` | `boolean` | Yes |  |
| `protocolRevision` | `string` | Yes |  |

#### Errors

- **AuthRequired**
- **AccessRemoved**
- **UnsupportedPDS**
- **ProtocolRevisionMismatch**
- **UpstreamUnavailable**

## Raw Schema

```json
{
  "id": "blue.catbird.circle.getCapabilities",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "AuthRequired"
        },
        {
          "name": "AccessRemoved"
        },
        {
          "name": "UnsupportedPDS"
        },
        {
          "name": "ProtocolRevisionMismatch"
        },
        {
          "name": "UpstreamUnavailable"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "enabled",
            "protocolRevision",
            "supportsImages"
          ],
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "supportsImages": {
              "type": "boolean"
            },
            "protocolRevision": {
              "type": "string"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Get capability metadata for Catbird Circles support"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```