board-github
GET /v1/board-github/links/{linkId}
One connection, with its WIP report and its open notices.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId} \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
The connection screen's whole payload in one call: the project, its fields with their options, the per-status counts against any WIP limits, and the notices GitHub does not raise — overdue items, items nothing has touched for a fortnight, and columns over their limit. `last_synced_at` and `last_attempted_at` are both returned and are different questions: a connection GitHub keeps refusing has a recent attempt and a stale success, and reporting only the first would show a healthy timestamp on a connection that has been broken for a week.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
linkId (path) | string | 是 | The GitHub Projects connection. |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | string | 否 | — |
board_id | string | 否 | — |
auth_kind | GitHubAuthKind | 否 | `app` is the Zinn® GitHub App installation — per-repository scope the customer chooses on GitHub's own screen, revocable by them in one click, belonging to their organisation ra… |
installation_id | string | 否 | Public — it appears in the customer's own install URL — and showing it is what lets them confirm on GitHub that they are looking at the right installation. |
has_stored_token | boolean | 否 | Whether a token is held in Vault for this connection. The token itself is never returned. |
project_node_id | string | 否 | — |
project_number | integer | 否 | — |
owner_login | string | 否 | — |
owner_type | string | 否 | — |
title | string | 否 | — |
short_description | string | 否 | — |
closed | boolean | 否 | — |
public | boolean | 否 | — |
direction | GitHubSyncDirection | 否 | `both` is the default (owner ruling, 2026-09-03: a new connection is read-write immediately). `pull` is the honest remedy when a push keeps being refused. |
notice_delivery | GitHubNoticeDelivery | 否 | Where a connection's overdue / gone-quiet / over-WIP notices are allowed to go. Both values raise the same notices and both render them on the board — the difference is delivery… |
views | object[] | 否 | The project's saved views on GitHub, replaced whole on every read so a view deleted there disappears here rather than lingering as a link GitHub answers with a 404. Rendered as… |
url | string | 否 | — |
webhook_state | GitHubWebhookState | 否 | Whether GitHub pushes changes at us, and if not, whose move it is. **Three outcomes and not a boolean.** `automatic` — we created the organisation webhook. `manual` — GitHub wou… |
last_synced_at | string | 否 | When a sync last SUCCEEDED. What the staleness alarm fires off. |
last_attempted_at | string | 否 | When a sync was last ATTEMPTED, stamped for every connection the sweep reaches before the result is read. Two columns rather than one: a cursor only a successful pass advanced w… |
last_error | string | 否 | — |
created_at | string | 否 | — |
fields | GitHubProjectField[] | 否 | The project's fields, with their single-select options and any work-in-progress limits set on them. Returned with the connection rather than fetched separately, because a board… |
wip | GitHubProjectStatusCount[] | 否 | — |
notices | GitHubProjectNotice[] | 否 | — |
此端点可能返回的错误
401 · 403 · 404