board-github

GET /v1/board-github/links

The GitHub Projects this organisation has connected.

Alle board-github Endpunkte

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 \
  -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

Each row carries `webhook_state`, which is the honest answer to *"is GitHub pushing changes at us, or are we polling?"*. It has three outcomes and not two: `automatic` (we created the hook), `manual` (GitHub would not let us, so the customer creates it and we hand them the URL and secret) and `failed`. `manual` is the commonest and is an instruction, not an error — creating an organisation webhook needs a permission most customers will not grant. The five-minute reconciliation sweep covers a project in every state, so this decides latency and never correctness.

Parameter

NameTypErforderlichWas es ist
board_id (query)stringNeinOnly links surfaced alongside this board.
cursor (query)stringNeinOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerNeinMaximum items to return (page size).

Antwort

NameTypErforderlichWas es ist
dataGitHubProjectLink[]Ja
pagePageMetaJa

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403