# town.delve.notification.listNotifications

> 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.notification.listNotifications)
- [Documentation](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.notification.listNotifications/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.notification.listNotifications/examples)

## Definitions

### `town.delve.notification.listNotifications`

**Type**: `query`

Enumerate notifications for the requesting account. Requires auth.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `limit` | `integer` | No |  |
| `priority` | `boolean` | No |  |
| `reasons` | `array` | No | Notification reasons to include in response. |
| `seenAt` | `string` (datetime) | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `notifications` | `array` | Yes |  |
| `priority` | `boolean` | No |  |
| `seenAt` | `string` (datetime) | No |  |

### `town.delve.notification.listNotifications#notification`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `author` | `ref` → `town.delve.actor.defs#profileView` | Yes |  |
| `cid` | `string` (cid) | Yes |  |
| `indexedAt` | `string` (datetime) | Yes |  |
| `isRead` | `boolean` | Yes |  |
| `labels` | `array` | No |  |
| `reason` | `string` | Yes | The reason why this notification was delivered - e.g. your post was liked, or you received a new follower. |
| `reasonSubject` | `string` (at-uri) | No |  |
| `record` | `unknown` | Yes |  |
| `starterPack` | `ref` → `town.delve.graph.defs#starterPackViewBasic` | No | The starter pack associated with this notification. Present when the notification is for a follow originating from a starter pack. |
| `uri` | `string` (at-uri) | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Enumerate notifications for the requesting account. Requires auth.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "type": "string"
            },
            "notifications": {
              "items": {
                "ref": "#notification",
                "type": "ref"
              },
              "type": "array"
            },
            "priority": {
              "type": "boolean"
            },
            "seenAt": {
              "format": "datetime",
              "type": "string"
            }
          },
          "required": [
            "notifications"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "priority": {
            "type": "boolean"
          },
          "reasons": {
            "description": "Notification reasons to include in response.",
            "items": {
              "description": "A reason that matches the reason property of #notification.",
              "type": "string"
            },
            "type": "array"
          },
          "seenAt": {
            "format": "datetime",
            "type": "string"
          }
        },
        "type": "params"
      },
      "type": "query"
    },
    "notification": {
      "properties": {
        "author": {
          "ref": "town.delve.actor.defs#profileView",
          "type": "ref"
        },
        "cid": {
          "format": "cid",
          "type": "string"
        },
        "indexedAt": {
          "format": "datetime",
          "type": "string"
        },
        "isRead": {
          "type": "boolean"
        },
        "labels": {
          "items": {
            "ref": "com.atproto.label.defs#label",
            "type": "ref"
          },
          "type": "array"
        },
        "reason": {
          "description": "The reason why this notification was delivered - e.g. your post was liked, or you received a new follower.",
          "knownValues": [
            "like",
            "repost",
            "follow",
            "mention",
            "reply",
            "quote",
            "starterpack-joined",
            "verified",
            "unverified",
            "like-via-repost",
            "repost-via-repost",
            "subscribed-post",
            "contact-match"
          ],
          "type": "string"
        },
        "reasonSubject": {
          "format": "at-uri",
          "type": "string"
        },
        "record": {
          "type": "unknown"
        },
        "starterPack": {
          "description": "The starter pack associated with this notification. Present when the notification is for a follow originating from a starter pack.",
          "ref": "town.delve.graph.defs#starterPackViewBasic",
          "type": "ref"
        },
        "uri": {
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "cid",
        "author",
        "reason",
        "record",
        "isRead",
        "indexedAt"
      ],
      "type": "object"
    }
  },
  "id": "town.delve.notification.listNotifications",
  "lexicon": 1
}
```