# com.getorbyt.community.listModmailThreads

> 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.community.listModmailThreads)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.community.listModmailThreads/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.community.listModmailThreads/examples)

## Definitions

### `com.getorbyt.community.listModmailThreads`

**Type**: `query`

The mod team's Modmail inbox: one thread per member, most recent message first, each marked unread when the member wrote since this moderator last read it. Requires manage-mail. Viewer-specific and never cached.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `community` | `string` (at-uri) | Yes |  |
| `cursor` | `string` | No |  |
| `limit` | `integer` | No |  |
| `status` | `string` | No |  |

#### Output

**Encoding**: `application/json`

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

#### Errors

- **AuthenticationRequired**
- **CommunityNotFound**
- **InsufficientRole**
- **InvalidRequest**
- **InvalidCursor**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "The mod team's Modmail inbox: one thread per member, most recent message first, each marked unread when the member wrote since this moderator last read it. Requires manage-mail. Viewer-specific and never cached.",
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "CommunityNotFound"
        },
        {
          "name": "InsufficientRole"
        },
        {
          "name": "InvalidRequest"
        },
        {
          "name": "InvalidCursor"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "type": "string"
            },
            "threads": {
              "items": {
                "ref": "com.getorbyt.community.defs#modmailThreadView",
                "type": "ref"
              },
              "maxLength": 50,
              "type": "array"
            }
          },
          "required": [
            "threads"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "community": {
            "format": "at-uri",
            "type": "string"
          },
          "cursor": {
            "type": "string"
          },
          "limit": {
            "default": 25,
            "maximum": 50,
            "minimum": 1,
            "type": "integer"
          },
          "status": {
            "default": "open",
            "knownValues": [
              "open",
              "archived"
            ],
            "type": "string"
          }
        },
        "required": [
          "community"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "com.getorbyt.community.listModmailThreads",
  "lexicon": 1
}
```
