Organisations
List a tab's revisions as an agent
The tab's revisions the caller may see: an agent sees its member's, and those shared with the board or with its member.
GET
/v1/boards/{board}/tabs/{tab}/revisionsTL;DR
| Question | Answer |
|---|---|
| What does it do? | List a tab's revisions as an agent. |
| What does it take? | board, tab in the path. |
| What does it return? | Status 200 with a body of type AgentBoardRevisionList. |
| What can go wrong? | 401 the API key is missing or not valid; 403 the account's plan does not include the REST API (plan.rest_not_included), the key is a person's own (boards.org_key_required), a trusted publisher (boards.publisher_not_allowed), an organisation key without the boards scope (key.scope_missing), boards are not on (boards.not_enabled), or the caller may look but not change the board (boards.forbidden); 404 no such board, tab or revision, or one not open to the caller (boards.revision_not_found): the cases look alike; 429 too many requests, or a daily limit is spent; 503 live whiteboards are not set up on this server. Every failure uses the one error envelope. |
What it does
The tab's revisions the caller may see: an agent sees its member's, and those shared with the board or with its member. The REST twin of the MCP tool list_revisions.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
board | string | yes | The board's id: 22 letters and digits. |
tab | string | yes | The tab's id: 12 letters and digits. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The revisions. | AgentBoardRevisionList |
| 401 | The API key is missing or not valid. | ErrorResponse |
| 403 | The account's plan does not include the REST API (plan.rest_not_included), the key is a person's own (boards.org_key_required), a trusted publisher (boards.publisher_not_allowed), an organisation key without the boards scope (key.scope_missing), boards are not on (boards.not_enabled), or the caller may look but not change the board (boards.forbidden). | ErrorResponse |
| 404 | No such board, tab or revision, or one not open to the caller (boards.revision_not_found): the cases look alike. | ErrorResponse |
| 429 | Too many requests, or a daily limit is spent. | ErrorResponse |
| 503 | Live whiteboards are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type AgentBoardRevisionList.
| Field | Type | Required | Description |
|---|---|---|---|
mainVersion | integer | yes | |
protected | boolean | yes | True when a merge into main needs the approval of a person who manages the board. |
revisions | BoardRevision[] | yes | |
revisions[].id | string | yes | at least 12 characters; at most 12 characters; pattern ^[0-9A-Za-z]+$. |
revisions[].tab | string | yes | |
revisions[].name | string | yes | |
revisions[].author | RevisionPerson | yes | |
revisions[].author.kind | "person" | "agent" | "key" | yes | |
revisions[].author.label | string | yes | |
revisions[].authorId | string | null | yes | |
revisions[].visibility | "private" | "board" | "people" | yes | private: the author only; board: everyone the board is open to; people: the author and the people named. |
revisions[].people | string[] | yes | The account ids it is shared with by name. |
revisions[].status | "open" | "pending" | "merged" | "discarded" | yes | open, pending (a merge waits for approval), merged, or discarded. |
revisions[].baseVersion | integer | yes | The main version it forked from, or was last updated from. |
revisions[].version | integer | yes | |
revisions[].behind | integer | yes | Main versions made since baseVersion. |
revisions[].createdAt | integer | yes | |
revisions[].updatedAt | integer | yes | |
revisions[].updatedBy | RevisionPerson | yes | |
revisions[].updatedBy.kind | "person" | "agent" | "key" | yes | |
revisions[].updatedBy.label | string | yes | |
revisions[].readable | boolean | yes | False for a private revision shown by its name only, to the people who manage the board. |
revisions[].mine | boolean | yes | |
revisions[].request | object | null | yes | |
revisions[].request.by | RevisionPerson | yes | |
revisions[].request.at | integer | yes | |
revisions[].request.note | string | null | yes | |
revisions[].review | object | null | yes | |
revisions[].review.by | RevisionPerson | yes | |
revisions[].review.at | integer | yes | |
revisions[].review.comment | string | null | yes | |
revisions[].mergedVersion | integer | null | yes | |
revisions[].mergedBy | any | yes | |
revisions[].mergedBy.kind | "person" | "agent" | "key" | yes | |
revisions[].mergedBy.label | string | yes | |
revisions[].closedAt | integer | null | yes | |
hidden | integer | yes | Open revisions the caller may not see. |
limit | integer | yes | Open revisions a tab may have. |
revisions | AgentBoardRevision[] | no | |
revisions[].id | string | yes | at least 12 characters; at most 12 characters; pattern ^[0-9A-Za-z]+$. |
revisions[].tab | string | yes | |
revisions[].name | string | yes | |
revisions[].author | RevisionPerson | yes | |
revisions[].author.kind | "person" | "agent" | "key" | yes | |
revisions[].author.label | string | yes | |
revisions[].visibility | "private" | "board" | "people" | yes | private: the author only; board: everyone the board is open to; people: the author and the people named. |
revisions[].status | "open" | "pending" | "merged" | "discarded" | yes | open, pending (a merge waits for approval), merged, or discarded. |
revisions[].baseVersion | integer | yes | The main version it forked from, or was last updated from. |
revisions[].version | integer | yes | |
revisions[].behind | integer | yes | Main versions made since baseVersion. |
revisions[].createdAt | integer | yes | |
revisions[].updatedAt | integer | yes | |
revisions[].updatedBy | RevisionPerson | yes | |
revisions[].updatedBy.kind | "person" | "agent" | "key" | yes | |
revisions[].updatedBy.label | string | yes | |
revisions[].readable | boolean | yes | False for a private revision shown by its name only, to the people who manage the board. |
revisions[].mine | boolean | yes | |
revisions[].request | object | null | yes | |
revisions[].request.by | RevisionPerson | yes | |
revisions[].request.at | integer | yes | |
revisions[].request.note | string | null | yes | |
revisions[].review | object | null | yes | |
revisions[].review.by | RevisionPerson | yes | |
revisions[].review.at | integer | yes | |
revisions[].review.comment | string | null | yes | |
revisions[].mergedVersion | integer | null | yes | |
revisions[].mergedBy | any | yes | |
revisions[].mergedBy.kind | "person" | "agent" | "key" | yes | |
revisions[].mergedBy.label | string | yes | |
revisions[].closedAt | integer | null | yes | |
revisions[].shared | integer | yes | People it is shared with by name. |
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 |