Organisations
Read one tab of a board
The tab with its whole source and version, and with since, what changed after that version: who changed it and what was added, removed or changed.
GET
/orgs/{org}/boards/{board}/tabs/{tab}TL;DR
| Question | Answer |
|---|---|
| What does it do? | Read one tab of a board. |
| What does it take? | org, board, tab in the path, and since in the query string. |
| What does it return? | Status 200 with a body of type BoardTabRead. |
| 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 tab with its whole source and version, and with since, what changed after that version: who changed it and what was added, removed or changed. Anyone the board is open to may read.
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. |
tab | string | yes | The tab's id: 12 letters and digits. |
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
since | integer | null | no |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The tab. | BoardTabRead |
| 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 BoardTabRead.
| Field | Type | Required | Description |
|---|---|---|---|
tab | BoardTab | yes | |
tab.id | string | yes | at least 12 characters; at most 12 characters; pattern ^[0-9A-Za-z]+$. |
tab.name | string | yes | |
tab.kind | string | yes | The kind the source declares, such as flow. |
tab.position | number | yes | |
tab.version | integer | yes | |
tab.updatedAt | integer | yes | |
tab.updatedBy | string | yes | Who changed it last: an email address, an agent and its member, or a key name. |
tab.library | object | null | yes | |
tab.library.diagramId | string | yes | |
tab.library.version | integer | yes | |
tab.library.saved | boolean | yes | True while the tab holds what was saved or imported. |
source | string | yes | |
changesSince | BoardHistoryEntry[] | yes | |
changesSince[].version | integer | yes | |
changesSince[].type | string | yes | |
changesSince[].actor | BoardActor | yes | |
changesSince[].actor.kind | "person" | "agent" | "key" | yes | |
changesSince[].actor.label | string | yes | |
changesSince[].counts | object | yes | |
changesSince[].counts.added | integer | yes | |
changesSince[].counts.removed | integer | yes | |
changesSince[].counts.renamed | integer | yes | |
changesSince[].counts.moved | integer | yes | |
changesSince[].counts.changed | integer | yes | |
changesSince[].at | integer | yes | |
changesSince[].restorable | boolean | yes |
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 |