board-github

GET `/v1/board-github/roadmap`

A dated timeline across every linked GitHub Project.

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.

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

Built from whichever DATE and ITERATION fields each project actually has. Lanes are the iteration where a project has one and the project where it does not, so one timeline stays readable across a sprint-driven engineering project and a date-driven client project at once. GitHub's own roadmap layout can do neither — it is per-project and cannot see our board cards. Items with no date are **omitted and counted** in `items_without_dates`, never given an invented date: a chart of our guesses would be worse than a gap.

Parameters

Name	Type	Required	What it is
`org_id (query)`	`string`	No	—

Response

Name	Type	Required	What it is
`count`	`integer`	No	—
`items_without_dates`	`integer`	No	Omitted from the timeline and counted here. A chart that invented a date for undated work would be a chart of our guesses.
`coverage_is_complete`	`boolean`	No	—
`entries`	`GitHubProjectRoadmapEntry[]`	No	—

Errors this endpoint can return

401 · 403 · 422