board-github
GET /v1/board-github/links
The GitHub Projects this organisation has connected.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/board-github/links \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Each row carries `webhook_state`, which is the honest answer to *"is GitHub pushing changes at us, or are we polling?"*. It has three outcomes and not two: `automatic` (we created the hook), `manual` (GitHub would not let us, so the customer creates it and we hand them the URL and secret) and `failed`. `manual` is the commonest and is an instruction, not an error — creating an organisation webhook needs a permission most customers will not grant. The five-minute reconciliation sweep covers a project in every state, so this decides latency and never correctness.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
board_id (query) | string | 否 | Only links surfaced alongside this board. |
cursor (query) | string | 否 | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | 否 | Maximum items to return (page size). |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
data | GitHubProjectLink[] | 是 | — |
page | PageMeta | 是 | — |
此端点可能返回的错误
401 · 403