board-github
GET /v1/board-github/rollup
Every linked GitHub Project, summed into one view.
Authentication
Send an API key as a bearer token. The endpoint checks agency.board.view; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
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/rollup \
-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
GitHub shows one project at a time; this is the screen that does not exist there. An agency running four client projects gets one answer to "how much is in progress and how much is late". links_never_synced, links_failing and coverage_is_complete are part of the answer, not diagnostics. A roll-up that silently omitted a project which failed to sync would be a number somebody makes a staffing decision on, and "nothing is late" must never render the same as "I cannot see whether anything is late".
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | Required only when the caller holds the permission in several orgs. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
links_total | integer | No | — |
links_never_synced | integer | No | — |
links_failing | integer | No | — |
coverage_is_complete | boolean | No | Whether the counts describe every connected project. Named as a question about COVERAGE rather than health: a project that has never synced is not unhealthy, it is unmeasured, and… |
items_total | integer | No | — |
items_open | integer | No | — |
items_archived | integer | No | — |
items_unassigned | integer | No | — |
items_no_status | integer | No | — |
overdue | integer | No | — |
stale | integer | No | — |
due_next_7_days | integer | No | — |
by_status | GitHubProjectStatusCount[] | No | — |
per_project | object[] | No | — |
Errors this endpoint can return
401 · 403 · 422