# Open a live whiteboard

> Page: https://docs.plotwork.dev/api/get-orgs-org-boards-board. Index of every page: https://docs.plotwork.dev/llms.txt

The board with its tabs, the caller's role on it, the numbers its live connection keeps to, and whether today's live minutes are left (liveAvailable).

`GET /orgs/{org}/boards/{board}`

## TL;DR

| Question | Answer |
|---|---|
| What does it do? | Open a live whiteboard. |
| What does it take? | `org`, `board` in the path. |
| What does it return? | Status 200 with a body of type [`Board`](https://docs.plotwork.dev/api/schemas.md#board). |
| What can go wrong? | `401` not signed in; `403` boards are not turned on for this organisation (boards.not_enabled), the caller may look but not change it (boards.forbidden), or the request came from an origin that may not make changes; `404` no such organisation, board or tab, or the board is not open to the caller: the cases look alike; `429` too many requests; `503` organisations or boards are not set up on this server. Every failure uses the one error envelope. |

## What it does

The board with its tabs, the caller's role on it, the numbers its live connection keeps to, and whether today's live minutes are left (liveAvailable). 404 alike for a board that does not exist and one not open to the caller.

## Path parameters

| Field | Type | Required | Description |
|---|---|---|---|
| `org` | `string` | yes | The organisation's id or its slug. |
| `board` | `string` | yes | The board's id: 22 letters and digits. |

## Responses

| Status | Meaning | Body |
|---|---|---|
| 200 | The board. | [`Board`](https://docs.plotwork.dev/api/schemas.md#board) |
| 401 | Not signed in. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 403 | Boards are not turned on for this organisation (boards.not_enabled), the caller may look but not change it (boards.forbidden), or the request came from an origin that may not make changes. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 404 | No such organisation, board or tab, or the board is not open to the caller: the cases look alike. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 429 | Too many requests. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 503 | Organisations or boards are not set up on this server. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |

## Response body

A 200 answer has the type [`Board`](https://docs.plotwork.dev/api/schemas.md#board).

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | `string` | yes | at least 22 characters; at most 22 characters; pattern `^[0-9A-Za-z]+$`. |
| `name` | `string` | yes |  |
| `classification` | `"public" \| "internal" \| "confidential"` | yes |  |
| `access` | `"org" \| "restricted"` | yes |  |
| `role` | `"view" \| "edit" \| "manage"` | yes | view: look; edit: change the tabs; manage: also change who may open the board. |
| `tabCount` | `integer` | yes | minimum 0. |
| `createdAt` | `integer` | yes |  |
| `updatedAt` | `integer` | yes |  |
| `createdBy` | `string \| null` | yes | The email address of the member who made it, or null when they left. |
| `live` | `boolean` | yes | True when someone opened its live connection in the last two minutes. |
| `kept` | `boolean` | yes |  |
| `live` | `boolean` | no |  |
| `orgRole` | `"view" \| "edit"` | yes | What every member gets when access is org. |
| `head` | `BoardHead` | yes |  |
| `head.id` | `string` | yes | at least 22 characters; at most 22 characters; pattern `^[0-9A-Za-z]+$`. |
| `head.orgId` | `string` | yes |  |
| `head.version` | `integer` | yes |  |
| `head.tabs` | `BoardTab[]` | yes |  |
| `head.tabs[].id` | `string` | yes | at least 12 characters; at most 12 characters; pattern `^[0-9A-Za-z]+$`. |
| `head.tabs[].name` | `string` | yes |  |
| `head.tabs[].kind` | `string` | yes | The kind the source declares, such as flow. |
| `head.tabs[].position` | `number` | yes |  |
| `head.tabs[].version` | `integer` | yes |  |
| `head.tabs[].updatedAt` | `integer` | yes |  |
| `head.tabs[].updatedBy` | `string` | yes | Who changed it last: an email address, an agent and its member, or a key name. |
| `head.tabs[].library` | `object \| null` | yes |  |
| `limits` | `BoardLiveLimits` | yes |  |
| `limits.sessionMinutes` | `integer` | yes |  |
| `limits.idleMinutes` | `integer` | yes |  |
| `limits.hiddenGraceSeconds` | `integer` | yes |  |
| `limits.participants` | `integer` | yes |  |
| `limits.tabs` | `integer` | yes |  |
| `liveAvailable` | `boolean` | yes | False when today's live minutes are spent: the board opens read-only and reloads its tabs by hand. |
| `url` | `string` | yes | The board's address in the portal. |
| `shortUrl` | `string` | yes | The short address, for chat and a QR code. |

## See also

| Doc | Why |
|---|---|
| [API reference](https://docs.plotwork.dev/api/reference.md) | Every endpoint, and the error envelope |
| [Schemas](https://docs.plotwork.dev/api/schemas.md) | Every request and response type |
| [Tool reference](https://docs.plotwork.dev/mcp/tools.md) | The operations as callable tools |