# social.colibri.beta.notification.getUnreadCount

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

✓ This is the authoritative definition for this NSID.

## Links

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

## Definitions

### `social.colibri.beta.notification.getUnreadCount`

**Type**: `query`

Gets how many of the requesting user's notifications are unread.

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `count` | `integer` | Yes | Number of unread notifications. |

#### Errors

- **AuthRequired**: The request has no valid service auth.

## Raw Schema

```json
{
  "id": "social.colibri.beta.notification.getUnreadCount",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "AuthRequired",
          "description": "The request has no valid service auth."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "count"
          ],
          "properties": {
            "count": {
              "type": "integer",
              "description": "Number of unread notifications."
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Gets how many of the requesting user's notifications are unread."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```