Organisations
Whether the organisation allows guests on its boards
The owner's setting "Allow guests on boards", and how many boards share their link with guests now.
GET
/orgs/{org}/sharing/board-guestsTL;DR
| Question | Answer |
|---|---|
| What does it do? | Whether the organisation allows guests on its boards. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type OrgBoardGuests. |
| What can go wrong? | 401 not signed in; 404 no such organisation, or the caller is not a member of it; 429 too many requests; 503 live whiteboards are not available on this server. Every failure uses the one error envelope. |
What it does
The owner's setting "Allow guests on boards", and how many boards share their link with guests now. Every member may read it.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The setting. | OrgBoardGuests |
| 401 | Not signed in. | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Live whiteboards are not available on this server. | ErrorResponse |
Response body
A 200 answer has the type OrgBoardGuests.
| Field | Type | Required | Description |
|---|---|---|---|
allowGuests | boolean | yes | Whether a board may be shared with anyone signed in, read only. Off by default. |
sharedBoards | integer | yes | Boards that share their link with guests now (their label is not Confidential). |
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 |