# tools.umbrae.list

> A hidden list of accounts. A personal list sits at a TID key in its owner's only-me space; a shared list is a tools.umbrae.listSpace space, with this record at key self. Never in a public repo.

- Kind: record
- Record key: any
- Authority: umbrae.tools
- Lexicon: 1
- Published by [lexicons.umbrae.tools](https://lexicon.garden/identity/did:plc:656sqbhftme2qbyjtcc2q6jk), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:656sqbhftme2qbyjtcc2q6jk/tools.umbrae.list)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:656sqbhftme2qbyjtcc2q6jk/tools.umbrae.list/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:656sqbhftme2qbyjtcc2q6jk/tools.umbrae.list/analytics)

## Record (`tools.umbrae.list`)

Type: record · key any

### Properties

- `createdAt` (string · datetime, required)
- `description` (string)
  - Constraints: maxLength: 3000, maxGraphemes: 300
- `name` (string, required)
  - Constraints: minLength: 1, maxLength: 640, maxGraphemes: 64
- `purpose` (string, required)
  - Constraints: enum: block | mute | curate

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "A hidden list of accounts. A personal list sits at a TID key in its owner's only-me space; a shared list is a tools.umbrae.listSpace space, with this record at key self. Never in a public repo.",
      "key": "any",
      "record": {
        "properties": {
          "createdAt": {
            "format": "datetime",
            "type": "string"
          },
          "description": {
            "maxGraphemes": 300,
            "maxLength": 3000,
            "type": "string"
          },
          "name": {
            "maxGraphemes": 64,
            "maxLength": 640,
            "minLength": 1,
            "type": "string"
          },
          "purpose": {
            "enum": [
              "block",
              "mute",
              "curate"
            ],
            "type": "string"
          }
        },
        "required": [
          "purpose",
          "name",
          "createdAt"
        ],
        "type": "object"
      },
      "type": "record"
    }
  },
  "id": "tools.umbrae.list",
  "lexicon": 1
}
```
