# social.colibri.beta.channel.listUnreadStatus

> 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.channel.listUnreadStatus)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.channel.listUnreadStatus/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.channel.listUnreadStatus/examples)

## Definitions

### `social.colibri.beta.channel.listUnreadStatus`

**Type**: `query`

Lists per-channel unread state for the requesting user.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No | Maximum number of statuses to return. |
| `community` | `string` (did) | No | Restricts the results to one community. Absent returns unread state across all of the requesting user's communities. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `statuses` | `array` | Yes | Unread state per channel. |

#### Errors

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

## Raw Schema

```json
{
  "id": "social.colibri.beta.channel.listUnreadStatus",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "AuthRequired",
          "description": "The request has no valid service auth."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "statuses"
          ],
          "properties": {
            "statuses": {
              "type": "array",
              "items": {
                "ref": "social.colibri.beta.channel.defs#unreadStatus",
                "type": "ref"
              },
              "description": "Unread state per channel."
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "description": "Maximum number of statuses to return."
          },
          "community": {
            "type": "string",
            "format": "did",
            "description": "Restricts the results to one community. Absent returns unread state across all of the requesting user's communities."
          }
        }
      },
      "description": "Lists per-channel unread state for the requesting user."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```