# blue.catbird.circle.metadata

> 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.metadata)
- [Documentation](https://lexicon.garden/lexicon/did:plc:xg4h4n7w5mh3m4uoi27me4hh/blue.catbird.circle.metadata/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:xg4h4n7w5mh3m4uoi27me4hh/blue.catbird.circle.metadata/examples)

## Definitions

### `blue.catbird.circle.metadata`

**Type**: `record`

Circle metadata, authored by the Space authority into its own permissioned repo. The only Catbird-specific record type in a Circle; posts and likes are unmodified Bluesky records.

**Key**: `literal:self`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes |  |
| `circleId` | `string` (tid) | Yes | Stable Circle identity, independent of the Space key. Survives migration to a different Space, which is the only identifier that does. |
| `createdAt` | `string` (datetime) | Yes |  |
| `migratedTo` | `string` (space-ref) | No | The Space this Circle's content was migrated to, if any. Set when the Circle has moved and this Space is retained read-only. |
| `migratedFrom` | `string` (space-ref) | No | The Space this Circle's content was migrated from, if any. |

## Raw Schema

```json
{
  "id": "blue.catbird.circle.metadata",
  "defs": {
    "main": {
      "key": "literal:self",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "circleId",
          "name",
          "createdAt"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 64,
            "minLength": 1
          },
          "circleId": {
            "type": "string",
            "format": "tid",
            "description": "Stable Circle identity, independent of the Space key. Survives migration to a different Space, which is the only identifier that does."
          },
          "createdAt": {
            "type": "string",
            "format": "datetime"
          },
          "migratedTo": {
            "type": "string",
            "format": "space-ref",
            "description": "The Space this Circle's content was migrated to, if any. Set when the Circle has moved and this Space is retained read-only."
          },
          "migratedFrom": {
            "type": "string",
            "format": "space-ref",
            "description": "The Space this Circle's content was migrated from, if any."
          }
        }
      },
      "description": "Circle metadata, authored by the Space authority into its own permissioned repo. The only Catbird-specific record type in a Circle; posts and likes are unmodified Bluesky records."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```