board-github
GET /v1/board-github/links/{linkId}
One connection, with its WIP report and its open notices.
Autenticazione
Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId} \
-H "Authorization: Bearer zdk_live_…"Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
linkId (path) | string | Sì | The GitHub Projects connection. |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
id | string | No | — |
board_id | string | No | — |
auth_kind | GitHubAuthKind | No | `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 | No | 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 | No | Whether a token is held in Vault for this connection. The token itself is never returned. |
project_node_id | string | No | — |
project_number | integer | No | — |
owner_login | string | No | — |
owner_type | string | No | — |
title | string | No | — |
short_description | string | No | — |
closed | boolean | No | — |
public | boolean | No | — |
direction | GitHubSyncDirection | No | `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 | No | 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[] | No | 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 | No | — |
webhook_state | GitHubWebhookState | No | 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 | No | When a sync last SUCCEEDED. What the staleness alarm fires off. |
last_attempted_at | string | No | 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 | No | — |
created_at | string | No | — |
fields | GitHubProjectField[] | No | 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[] | No | — |
notices | GitHubProjectNotice[] | No | — |
Errori che questo endpoint può restituire
401 · 403 · 404