agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
boardId (path) | Uuid | 是 | Project board ID (UUIDv7). |
include_archived (query) | boolean | 否 | Include archived cards in `cards`. ⛔ This parameter was on `/cards` from the day the board shipped and NOT here — and this is the endpoint the board screen calls, so an archived… |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | 是 | The agency that owns this board. |
client_org_id | string | 否 | The client organisation this board's work is for, if any. This is what authorises a client's read — never the org tree, because "is a descendant of the agency" is a weaker claim… |
client_org_name | string | 否 | That client organisation's name, resolved by the engine. `client_org_id` set with this `null` is a real state and not an error — the board names a client the caller may not read… |
name | string | 是 | — |
description | string | 否 | — |
archived_at | string | 否 | — |
open_question_count | integer | 否 | — |
created_at | string | 是 | — |
updated_at | string | 否 | — |
created_by | AgencyBoardActor | 否 | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | 否 | Who last changed the board itself — its name, description or client organisation. ⛔ NOT "who last touched anything on it": that is the activity feed. It moves exactly when `upda… |
columns | AgencyBoardColumn[] | 否 | — |
cards | AgencyBoardCard[] | 否 | — |
labels | AgencyBoardLabel[] | 否 | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
此端点可能返回的错误
401 · 403 · 404