Organisations
Find the organisation of a board
For the short link /b/{board}: the organisation slug, answered only to a person the board is open to.
GET
/user/boards/{board}/whereTL;DR
| Question | Answer |
|---|---|
| What does it do? | Find the organisation of a board. |
| What does it take? | board in the path. |
| What does it return? | Status 200 with a body of type BoardWhere. |
| What can go wrong? | 401 not signed in; 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
For the short link /b/{board}: the organisation slug, answered only to a person the board is open to. Everyone else, and an id that names no board, gets the same 404 boards.not_found.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
board | string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | Where the board is. | BoardWhere |
| 401 | Not signed in. | 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 BoardWhere.
| Field | Type | Required | Description |
|---|---|---|---|
slug | string | yes | |
board | string | yes | at least 22 characters; at most 22 characters; pattern ^[0-9A-Za-z]+$. |
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 |