# app.atmobb.forum.getWatchers

> Published by [lexicons.atmobb.app](https://lexicon.garden/identity/did:plc:dqnwiguwsbb6uwrm7a2rsff2)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:dqnwiguwsbb6uwrm7a2rsff2/app.atmobb.forum.getWatchers)
- [Documentation](https://lexicon.garden/lexicon/did:plc:dqnwiguwsbb6uwrm7a2rsff2/app.atmobb.forum.getWatchers/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:dqnwiguwsbb6uwrm7a2rsff2/app.atmobb.forum.getWatchers/examples)

## Definitions

### `app.atmobb.forum.getWatchers`

**Type**: `query`

Members watching a board, minus anyone the forum has banned. Ordered by DID.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `board` | `string` (at-uri) | Yes |  |
| `cursor` | `string` | No |  |
| `forum` | `string` (did) | Yes |  |
| `limit` | `integer` | No |  |

#### Output

**Encoding**: `application/json`

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

### `app.atmobb.forum.getWatchers#watcher`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Members watching a board, minus anyone the forum has banned. Ordered by DID.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "type": "string"
            },
            "watchers": {
              "items": {
                "ref": "#watcher",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "watchers"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "board": {
            "format": "at-uri",
            "type": "string"
          },
          "cursor": {
            "type": "string"
          },
          "forum": {
            "format": "did",
            "type": "string"
          },
          "limit": {
            "default": 100,
            "maximum": 500,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "forum",
          "board"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "watcher": {
      "properties": {
        "did": {
          "format": "did",
          "type": "string"
        }
      },
      "required": [
        "did"
      ],
      "type": "object"
    }
  },
  "id": "app.atmobb.forum.getWatchers",
  "lexicon": 1
}
```