# app.atmobb.forum.getBoardIndex

> 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.getBoardIndex)
- [Documentation](https://lexicon.garden/lexicon/did:plc:dqnwiguwsbb6uwrm7a2rsff2/app.atmobb.forum.getBoardIndex/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:dqnwiguwsbb6uwrm7a2rsff2/app.atmobb.forum.getBoardIndex/examples)

## Definitions

### `app.atmobb.forum.getBoardIndex`

**Type**: `query`

Board index for a forum: boards with thread counts and latest activity.

#### Parameters

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

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `boards` | `array` | Yes |  |
| `forum` | `unknown` | No |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Board index for a forum: boards with thread counts and latest activity.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "boards": {
              "items": {
                "type": "unknown"
              },
              "type": "array"
            },
            "forum": {
              "type": "unknown"
            }
          },
          "required": [
            "boards"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "forum": {
            "format": "did",
            "type": "string"
          }
        },
        "required": [
          "forum"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "app.atmobb.forum.getBoardIndex",
  "lexicon": 1
}
```