board-github
POST /v1/board-github/links
Connect a GitHub Project to this organisation.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントは、JSONボディのフィールドとして org_id を受け取ります。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/board-github/links \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "project_node_id": <string>, "project_number": <integer>, "owner_login": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Two-way from the moment it is connected (owner ruling, 2026-09-03). The first sync runs inside this request, so the 201 already carries the project's fields — a connect that returned an empty board and left the customer waiting for the sweep would read as a broken connection. `auth_kind: app` stores only the **installation id**, which is public and appears in the customer's own install URL; nothing long-lived is at rest and an hour-long token is minted per use. `auth_kind: pat` writes the token straight to Vault and never echoes it.
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
project_node_id | string | はい | — |
project_number | integer | はい | — |
owner_login | string | はい | — |
owner_type | string<organization, user> | いいえ | — |
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 | いいえ | — |
token | string | いいえ | — |
board_id | string | いいえ | Optional. A project may be connected purely for the roll-up and never attached to client work. |
title | string | いいえ | — |
org_id | string | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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… |
このエンドポイントが返すエラー
401 · 403 · 422