# app.bivri.notif.getNotifications

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

✓ This is the authoritative definition for this NSID.

## Description

Get the authenticated member's notifications, paginated by cursor.

## Links

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

## Definitions

### `app.bivri.notif.getNotifications`

**Type**: `query`

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No |  |
| `cursor` | `string` | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `notifications` | `array` | Yes |  |

### `app.bivri.notif.getNotifications#notificationView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `id` | `integer` | Yes |  |
| `isRead` | `boolean` | Yes |  |
| `reason` | `string` | Yes |  |
| `sender` | `ref` → `app.bivri.actor.defs#profileView` | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `indexedAt` | `string` (datetime) | Yes |  |
| `subjectUri` | `string` (at-uri) | No |  |

## Raw Schema

```json
{
  "id": "app.bivri.notif.getNotifications",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "notifications"
          ],
          "properties": {
            "cursor": {
              "type": "string"
            },
            "notifications": {
              "type": "array",
              "items": {
                "ref": "#notificationView",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100,
            "minimum": 1
          },
          "cursor": {
            "type": "string"
          }
        }
      }
    },
    "notificationView": {
      "type": "object",
      "required": [
        "id",
        "reason",
        "isRead",
        "sender",
        "createdAt",
        "indexedAt"
      ],
      "properties": {
        "id": {
          "type": "integer"
        },
        "isRead": {
          "type": "boolean"
        },
        "reason": {
          "type": "string",
          "knownValues": [
            "like",
            "comment",
            "follow"
          ]
        },
        "sender": {
          "ref": "app.bivri.actor.defs#profileView",
          "type": "ref"
        },
        "createdAt": {
          "type": "string",
          "format": "datetime"
        },
        "indexedAt": {
          "type": "string",
          "format": "datetime"
        },
        "subjectUri": {
          "type": "string",
          "format": "at-uri"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "Get the authenticated member's notifications, paginated by cursor."
}
```