agency-board

GET /v1/agency/client/boards/{boardId}

The client's view of one board.

所有 agency-board 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

curl -X GET https://api.zinndigital.com/v1/agency/client/boards/{boardId} \
  -H "Authorization: Bearer zdk_live_…"

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

Returns **only** what the agency shared: columns marked client-visible, cards that are client-visible **and** sit in such a column, client-visible comments and attachments on those cards, and every question asked on them. ⛔ Anything not shared is absent from the response, not merely hidden in the UI. The payload is built by a hand-written projection with a test pinning its exact field set — it carries no assignee, no author identity beyond "from the client or not", no internal ids and no WIP limits.

参数

名称类型必填内容简介
boardId (path)UuidProject board ID (UUIDv7).

响应

名称类型必填内容简介
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestring
descriptionstring
open_question_countinteger
intake_column_idstring
columnsSharedAgencyBoardColumn[]
cardsSharedAgencyBoardCard[]
commentsSharedAgencyBoardComment[]
questionsSharedAgencyBoardQuestion[]
attachmentsSharedAgencyBoardAttachment[]

此端点可能返回的错误

401 · 403 · 404