# com.getorbyt.notification.listNotifications

> Published by [getorbyt.com](https://lexicon.garden/identity/did:plc:2xrqztnmzlckb3xfuuukupso)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.notification.listNotifications)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.notification.listNotifications/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.notification.listNotifications/examples)

## Definitions

### `com.getorbyt.notification.listNotifications`

**Type**: `query`

The viewer's Orbyt activity, newest first. Requires service auth.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `limit` | `integer` | No |  |
| `reasons` | `array` | No | Only these reasons. Absent means all. |

#### Output

**Encoding**: `application/json`

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

#### Errors

- **AuthenticationRequired**
- **InvalidCursor**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "The viewer's Orbyt activity, newest first. Requires service auth.",
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "InvalidCursor"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "type": "string"
            },
            "notifications": {
              "items": {
                "ref": "com.getorbyt.notification.defs#notificationView",
                "type": "ref"
              },
              "maxLength": 100,
              "type": "array"
            },
            "seenAt": {
              "format": "datetime",
              "type": "string"
            }
          },
          "required": [
            "notifications"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "reasons": {
            "description": "Only these reasons. Absent means all.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "com.getorbyt.notification.listNotifications",
  "lexicon": 1
}
```
