board-github
GET /v1/board-github/links/{linkId}
One connection, with its WIP report and its open notices.
Pengesahan
Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId} \
-H "Authorization: Bearer zdk_live_…"Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
linkId (path) | string | Ya | The GitHub Projects connection. |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
id | string | Tidak | — |
board_id | string | Tidak | — |
auth_kind | GitHubAuthKind | Tidak | `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 | Tidak | 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 | Tidak | Whether a token is held in Vault for this connection. The token itself is never returned. |
project_node_id | string | Tidak | — |
project_number | integer | Tidak | — |
owner_login | string | Tidak | — |
owner_type | string | Tidak | — |
title | string | Tidak | — |
short_description | string | Tidak | — |
closed | boolean | Tidak | — |
public | boolean | Tidak | — |
direction | GitHubSyncDirection | Tidak | `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 | Tidak | 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[] | Tidak | 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 | Tidak | — |
webhook_state | GitHubWebhookState | Tidak | 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 | Tidak | When a sync last SUCCEEDED. What the staleness alarm fires off. |
last_attempted_at | string | Tidak | 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 | Tidak | — |
created_at | string | Tidak | — |
fields | GitHubProjectField[] | Tidak | 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[] | Tidak | — |
notices | GitHubProjectNotice[] | Tidak | — |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 404