board-github
GET /v1/board-github/links/{linkId}
One connection, with its WIP report and its open notices.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId} \
-H "Authorization: Bearer zdk_live_…"Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
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
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
linkId (path) | string | Ja | The GitHub Projects connection. |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
id | string | Nein | — |
board_id | string | Nein | — |
auth_kind | GitHubAuthKind | Nein | `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 | Nein | 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 | Nein | Whether a token is held in Vault for this connection. The token itself is never returned. |
project_node_id | string | Nein | — |
project_number | integer | Nein | — |
owner_login | string | Nein | — |
owner_type | string | Nein | — |
title | string | Nein | — |
short_description | string | Nein | — |
closed | boolean | Nein | — |
public | boolean | Nein | — |
direction | GitHubSyncDirection | Nein | `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 | Nein | 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[] | Nein | 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 | Nein | — |
webhook_state | GitHubWebhookState | Nein | 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 | Nein | When a sync last SUCCEEDED. What the staleness alarm fires off. |
last_attempted_at | string | Nein | 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 | Nein | — |
created_at | string | Nein | — |
fields | GitHubProjectField[] | Nein | 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[] | Nein | — |
notices | GitHubProjectNotice[] | Nein | — |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404