board-github

GET `/v1/board-github/links/{linkId}`

One connection, with its WIP report and its open notices.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId} \
  -H "Authorization: Bearer zdk_live_…"

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`linkId (path)`	`string`	Sim	The GitHub Projects connection.

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`string`	Não	—
`board_id`	`string`	Não	—
`auth_kind`	`GitHubAuthKind`	Não	`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`	Não	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`	Não	Whether a token is held in Vault for this connection. The token itself is never returned.
`project_node_id`	`string`	Não	—
`project_number`	`integer`	Não	—
`owner_login`	`string`	Não	—
`owner_type`	`string`	Não	—
`title`	`string`	Não	—
`short_description`	`string`	Não	—
`closed`	`boolean`	Não	—
`public`	`boolean`	Não	—
`direction`	`GitHubSyncDirection`	Não	`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`	Não	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[]`	Não	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`	Não	—
`webhook_state`	`GitHubWebhookState`	Não	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`	Não	When a sync last SUCCEEDED. What the staleness alarm fires off.
`last_attempted_at`	`string`	Não	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`	Não	—
`created_at`	`string`	Não	—
`fields`	`GitHubProjectField[]`	Não	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[]`	Não	—
`notices`	`GitHubProjectNotice[]`	Não	—

Erros que este endpoint pode retornar

401 · 403 · 404

GET /v1/board-github/links/{linkId}