Organisations
List the live whiteboards an agent or key may open
The boards of the key's organisation the caller may open, newest change first.
GET
/v1/boardsTL;DR
| Question | Answer |
|---|---|
| What does it do? | List the live whiteboards an agent or key may open. |
| What does it take? | query, limit in the query string. |
| What does it return? | Status 200 with a body of type AgentBoardList. |
| What can go wrong? | 400 the query is not valid; 401 the API key is missing or not valid; 403 the account's plan does not include the REST API (plan.rest_not_included), the key is a person's own or a person's own agent (boards.org_key_required), a trusted publisher (boards.publisher_not_allowed), an organisation key without the boards scope (key.scope_missing), boards are not on for the organisation (boards.not_enabled), or the caller may look but not change the board (boards.forbidden); 404 no such board or tab, or the board is not open to the caller: the cases look alike; 429 too many requests, or a daily limit is spent; 503 live whiteboards are not set up on this server. Every failure uses the one error envelope. |
What it does
The boards of the key's organisation the caller may open, newest change first. An agent connected to the organisation sees what its member sees; an organisation key with the boards scope sees the boards open to the whole organisation. A person's own key is 403 boards.org_key_required. The REST twin of the MCP tool list_boards.
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
query | string | no | Lists only the boards whose name holds this text, in any case. |
limit | integer | no | How many to list, 1 to 100. 20 when left out. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The boards. | AgentBoardList |
| 400 | The query is not valid. | ErrorResponse |
| 401 | The API key is missing or not valid. | ErrorResponse |
| 403 | The account's plan does not include the REST API (plan.rest_not_included), the key is a person's own or a person's own agent (boards.org_key_required), a trusted publisher (boards.publisher_not_allowed), an organisation key without the boards scope (key.scope_missing), boards are not on for the organisation (boards.not_enabled), or the caller may look but not change the board (boards.forbidden). | ErrorResponse |
| 404 | No such board or tab, or the board is not open to the caller: the cases look alike. | ErrorResponse |
| 429 | Too many requests, or a daily limit is spent. | ErrorResponse |
| 503 | Live whiteboards are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type AgentBoardList.
| Field | Type | Required | Description |
|---|---|---|---|
organization | object | yes | |
organization.id | string | yes | |
organization.slug | string | yes | |
organization.name | string | yes | |
boards | AgentBoardItem[] | yes | |
boards[].id | string | yes | at least 22 characters; at most 22 characters; pattern ^[0-9A-Za-z]+$. |
boards[].name | string | yes | |
boards[].classification | "public" | "internal" | "confidential" | yes | |
boards[].role | "view" | "edit" | "manage" | yes | What the caller may do: view, edit, or manage. An agent has its member's role; a key the role every member gets. |
boards[].tabs | integer | yes | minimum 0. |
boards[].updatedAt | integer | yes | |
boards[].live | boolean | yes | True when someone opened the board in the last two minutes. |
total | integer | yes | How many boards matched, which can be more than the ones listed. minimum 0. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |