board-github
GET /v1/board-github/links
The GitHub Projects this organisation has connected.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/board-github/links \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
board_id (query) | string | No | Only links surfaced alongside this board. |
cursor (query) | string | No | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | No | Maximum items to return (page size). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | GitHubProjectLink[] | Yes | — |
page | PageMeta | Yes | — |
Errors this endpoint can return
401 · 403