# so.sprk.notification.listNotifications

> Published by [sprk.so](https://lexicon.garden/identity/did:plc:cveom2iroj3mt747sd4qqnr2)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:cveom2iroj3mt747sd4qqnr2/so.sprk.notification.listNotifications)
- [Documentation](https://lexicon.garden/lexicon/did:plc:cveom2iroj3mt747sd4qqnr2/so.sprk.notification.listNotifications/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:cveom2iroj3mt747sd4qqnr2/so.sprk.notification.listNotifications/examples)

## Definitions

### `so.sprk.notification.listNotifications`

**Type**: `query`

Enumerate notifications for the requesting account. Requires auth.

#### Parameters

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

#### Output

**Encoding**: `application/json`

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

### `so.sprk.notification.listNotifications#notification`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |
| `author` | `ref` → `so.sprk.actor.defs#profileView` | Yes |  |
| `isRead` | `boolean` | Yes |  |
| `labels` | `array` | No |  |
| `reason` | `string` | Yes | Expected values are 'like', 'repost', 'follow', 'mention', 'reply', 'quote', and 'starterpack-joined'. |
| `record` | `unknown` | Yes |  |
| `indexedAt` | `string` (datetime) | Yes |  |
| `reasonSubject` | `string` (at-uri) | No |  |

## Raw Schema

```json
{
  "id": "so.sprk.notification.listNotifications",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "notifications"
          ],
          "properties": {
            "cursor": {
              "type": "string"
            },
            "seenAt": {
              "type": "string",
              "format": "datetime"
            },
            "priority": {
              "type": "boolean"
            },
            "notifications": {
              "type": "array",
              "items": {
                "ref": "#notification",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100,
            "minimum": 1
          },
          "cursor": {
            "type": "string"
          },
          "seenAt": {
            "type": "string",
            "format": "datetime"
          },
          "reasons": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "A reason that matches the reason property of #notification."
            },
            "description": "Notification reasons to include in response."
          },
          "priority": {
            "type": "boolean"
          }
        }
      },
      "description": "Enumerate notifications for the requesting account. Requires auth."
    },
    "notification": {
      "type": "object",
      "required": [
        "uri",
        "cid",
        "author",
        "reason",
        "record",
        "isRead",
        "indexedAt"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid"
        },
        "uri": {
          "type": "string",
          "format": "at-uri"
        },
        "author": {
          "ref": "so.sprk.actor.defs#profileView",
          "type": "ref"
        },
        "isRead": {
          "type": "boolean"
        },
        "labels": {
          "type": "array",
          "items": {
            "ref": "com.atproto.label.defs#label",
            "type": "ref"
          }
        },
        "reason": {
          "type": "string",
          "description": "Expected values are 'like', 'repost', 'follow', 'mention', 'reply', 'quote', and 'starterpack-joined'.",
          "knownValues": [
            "like",
            "repost",
            "follow",
            "mention",
            "reply",
            "like-via-repost",
            "repost-via-repost"
          ]
        },
        "record": {
          "type": "unknown"
        },
        "indexedAt": {
          "type": "string",
          "format": "datetime"
        },
        "reasonSubject": {
          "type": "string",
          "format": "at-uri"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```