# dev.jazco.boards.indexBoard

> Published by [jaztesting.jazco.dev](https://lexicon.garden/identity/did:plc:wj2ubhxdhdbmkjq3pzckk7gx)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:wj2ubhxdhdbmkjq3pzckk7gx/dev.jazco.boards.indexBoard)
- [Documentation](https://lexicon.garden/lexicon/did:plc:wj2ubhxdhdbmkjq3pzckk7gx/dev.jazco.boards.indexBoard/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:wj2ubhxdhdbmkjq3pzckk7gx/dev.jazco.boards.indexBoard/examples)

## Definitions

### `dev.jazco.boards.indexBoard`

**Type**: `procedure`

Ask the appview to index a board. Its owner first adds the appview's account as a read-only member; the appview then registers for the board's notifies and syncs it. Owner auth: a space credential issued to the board's owner.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `board` | `string` (uri) | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `board` | `string` (uri) | Yes |  |
| `spaceRev` | `string` | No |  |

#### Errors

- **NotAMember**: The appview's account can't get a credential for the board.
- **AuthRequired**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Ask the appview to index a board. Its owner first adds the appview's account as a read-only member; the appview then registers for the board's notifies and syncs it. Owner auth: a space credential issued to the board's owner.",
      "errors": [
        {
          "description": "The appview's account can't get a credential for the board.",
          "name": "NotAMember"
        },
        {
          "name": "AuthRequired"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "board": {
              "format": "uri",
              "type": "string"
            }
          },
          "required": [
            "board"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "board": {
              "format": "uri",
              "type": "string"
            },
            "spaceRev": {
              "type": "string"
            }
          },
          "required": [
            "board"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "dev.jazco.boards.indexBoard",
  "lexicon": 1
}
```