Organisations
Read who may open a board
The board general access (the whole organisation, or only the people and groups added), what every member gets, the grants with their roles, and for its managers the invite links that still work.
GET
/orgs/{org}/boards/{board}/accessTL;DR
| Question | Answer |
|---|---|
| What does it do? | Read who may open a board. |
| What does it take? | org, board in the path. |
| What does it return? | Status 200 with a body of type BoardAccess. |
| 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 general access (the whole organisation, or only the people and groups added), what every member gets, the grants with their roles, and for its managers the invite links that still work.
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 | Who may open the board. | BoardAccess |
| 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 BoardAccess.
| Field | Type | Required | Description |
|---|---|---|---|
access | "org" | "restricted" | yes | |
orgRole | "view" | "edit" | yes | |
grants | BoardGrant[] | yes | |
grants[].kind | "user" | "group" | yes | |
grants[].id | string | yes | |
grants[].name | string | yes | A member's email address, or a group's name. |
grants[].role | "view" | "edit" | "manage" | yes | view: look; edit: change the tabs; manage: also change who may open the board. |
joinLinks | BoardJoinLink[] | yes | |
joinLinks[].id | string | yes | |
joinLinks[].role | "view" | "edit" | yes | |
joinLinks[].createdAt | integer | yes | |
joinLinks[].expiresAt | integer | yes | |
canManage | boolean | yes | |
guestLink | boolean | yes | True when anyone signed in with the link may watch the board, as the board chose. |
guests | "ok" | "off" | "confidential" | yes | Whether guests may open the board now: ok, or off when the owner does not allow guests on boards, or confidential for a Confidential board. Only ok lets a guest in. |
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 |