# app.bivri.actor.getPreferences

> Published by [lexicons.bivri.app](https://lexicon.garden/identity/did:plc:uqat5a7hrbww3snbbinxgwah)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:uqat5a7hrbww3snbbinxgwah/app.bivri.actor.getPreferences)
- [Documentation](https://lexicon.garden/lexicon/did:plc:uqat5a7hrbww3snbbinxgwah/app.bivri.actor.getPreferences/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:uqat5a7hrbww3snbbinxgwah/app.bivri.actor.getPreferences/examples)

## Definitions

### `app.bivri.actor.getPreferences`

**Type**: `query`

Read the authenticated account's own preferences. Scoped to the caller and to nobody else: there is no parameter naming whose preferences to read, because one account's preferences are never another account's business. An account that has never set a preference reads the defaults rather than an absence, so a client has nothing to guess.

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `notifications` | `ref` → `app.bivri.actor.defs#notificationPreferences` | Yes |  |

#### Errors

- **Unauthenticated**: Nobody is authenticated, so there are no preferences to read.

## Raw Schema

```json
{
  "id": "app.bivri.actor.getPreferences",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "Unauthenticated",
          "description": "Nobody is authenticated, so there are no preferences to read."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "notifications"
          ],
          "properties": {
            "notifications": {
              "ref": "app.bivri.actor.defs#notificationPreferences",
              "type": "ref"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Read the authenticated account's own preferences. Scoped to the caller and to nobody else: there is no parameter naming whose preferences to read, because one account's preferences are never another account's business. An account that has never set a preference reads the defaults rather than an absence, so a client has nothing to guess."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```