Organisations
List an organisation's live whiteboards
The boards the caller may open, newest change first, with how many the organisation keeps and may keep.
GET
/orgs/{org}/boardsTL;DR
| Question | Answer |
|---|---|
| What does it do? | List an organisation's live whiteboards. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type BoardList. |
| 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 boards the caller may open, newest change first, with how many the organisation keeps and may keep. A board open to the whole organisation is listed for every member; a restricted one for the people and groups it names. 403 boards.not_enabled when the organisation's plan has no boards or the operator has not turned them on.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The boards. | BoardList |
| 401 | Not signed in. | 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 |
| 404 | No such organisation, board or tab, or the board is not open to the caller: the cases look alike. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations or boards are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type BoardList.
| Field | Type | Required | Description |
|---|---|---|---|
items | BoardListItem[] | yes | |
items[].id | string | yes | at least 22 characters; at most 22 characters; pattern ^[0-9A-Za-z]+$. |
items[].name | string | yes | |
items[].classification | "public" | "internal" | "confidential" | yes | |
items[].access | "org" | "restricted" | yes | |
items[].role | "view" | "edit" | "manage" | yes | view: look; edit: change the tabs; manage: also change who may open the board. |
items[].tabCount | integer | yes | minimum 0. |
items[].createdAt | integer | yes | |
items[].updatedAt | integer | yes | |
items[].createdBy | string | null | yes | The email address of the member who made it, or null when they left. |
items[].live | boolean | yes | True when someone opened its live connection in the last two minutes. |
items[].kept | boolean | yes | |
limit | integer | yes | Boards the organisation may keep. minimum 0. |
count | integer | yes | Boards the organisation keeps now, including those the caller may not open. 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 |