# org.swappulse.circle

> Published by [bridge.swappulse.org](https://lexicon.garden/identity/did:plc:jwoatauidzr4lollmro2gh35)

## Description

A collector circle (themed community group), mirrored to AT Protocol so circles are portable community objects across PDSs and SwapPulse instances.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:jwoatauidzr4lollmro2gh35/org.swappulse.circle)
- [Documentation](https://lexicon.garden/lexicon/did:plc:jwoatauidzr4lollmro2gh35/org.swappulse.circle/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:jwoatauidzr4lollmro2gh35/org.swappulse.circle/examples)

## Definitions

### `org.swappulse.circle`

**Type**: `record`

A collector circle.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes |  |
| `theme` | `string` | No |  |
| `region` | `string` | No |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `curatorDid` | `string` (did) | No |  |
| `memberDids` | `array` | No |  |
| `visibility` | `string` | Yes |  |
| `curatorName` | `string` | No |  |
| `description` | `string` | No |  |
| `memberCount` | `integer` | No |  |
| `curatorHandle` | `string` | No |  |
| `memberProfiles` | `array` | No |  |

## Raw Schema

```json
{
  "id": "org.swappulse.circle",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "name",
          "visibility",
          "createdAt"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 60
          },
          "theme": {
            "type": "string",
            "knownValues": [
              "vintage",
              "competitive",
              "shiny",
              "investment",
              "local_region",
              "artist",
              "general"
            ]
          },
          "region": {
            "type": "string"
          },
          "createdAt": {
            "type": "string",
            "format": "datetime"
          },
          "curatorDid": {
            "type": "string",
            "format": "did"
          },
          "memberDids": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "did"
            },
            "maxLength": 100
          },
          "visibility": {
            "type": "string",
            "knownValues": [
              "private",
              "members_visible",
              "public"
            ]
          },
          "curatorName": {
            "type": "string"
          },
          "description": {
            "type": "string",
            "maxLength": 200
          },
          "memberCount": {
            "type": "integer"
          },
          "curatorHandle": {
            "type": "string"
          },
          "memberProfiles": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "did": {
                  "type": "string",
                  "format": "did"
                },
                "name": {
                  "type": "string"
                },
                "avatar": {
                  "type": "string",
                  "format": "uri"
                },
                "handle": {
                  "type": "string"
                }
              }
            },
            "maxLength": 100
          }
        }
      },
      "description": "A collector circle."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1,
  "description": "A collector circle (themed community group), mirrored to AT Protocol so circles are portable community objects across PDSs and SwapPulse instances."
}
```