# social.colibri.notification.listNotifications

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.notification.listNotifications)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.notification.listNotifications/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.notification.listNotifications/examples)

## Definitions

### `social.colibri.notification.listNotifications`

**Type**: `query`

Lists the authenticated user's notifications, paginated.

#### 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 |  |

#### Errors

- **AuthRequired**: Missing, malformed, or unverifiable service auth.

## Raw Schema

```json
{
  "id": "social.colibri.notification.listNotifications",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "AuthRequired",
          "description": "Missing, malformed, or unverifiable service auth."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "notifications"
          ],
          "properties": {
            "cursor": {
              "type": "string"
            },
            "notifications": {
              "type": "array",
              "items": {
                "ref": "lex:social.colibri.notification.defs#notificationView",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "limit": {
            "type": "integer"
          },
          "cursor": {
            "type": "string"
          }
        }
      },
      "description": "Lists the authenticated user's notifications, paginated."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```