# town.delve.actor.getPreferences

> Published by [delve.town](https://lexicon.garden/identity/did:plc:qzqct2rrq4u2gmy5g3mjxske)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.actor.getPreferences)
- [Documentation](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.actor.getPreferences/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.actor.getPreferences/examples)

## Definitions

### `town.delve.actor.getPreferences`

**Type**: `query`

Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `preferences` | `ref` → `town.delve.actor.defs#preferences` | Yes |  |
| `stored` | `boolean` | No | Whether the responding service holds a committed preference set for this account. Set by an AppView store; false means nothing has ever been written (or it was erased), in which case preferences is empty. Absent when served from a PDS-local store. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "preferences": {
              "ref": "town.delve.actor.defs#preferences",
              "type": "ref"
            },
            "stored": {
              "description": "Whether the responding service holds a committed preference set for this account. Set by an AppView store; false means nothing has ever been written (or it was erased), in which case preferences is empty. Absent when served from a PDS-local store.",
              "type": "boolean"
            }
          },
          "required": [
            "preferences"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {},
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "town.delve.actor.getPreferences",
  "lexicon": 1
}
```
