board-github

GET `/v1/board-github/roadmap`

A dated timeline across every linked GitHub Project.

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.

Onde vai o ID da sua organização

Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

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

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.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`org_id (query)`	`string`	Não	—

Resposta

Nome	Tipo	Obrigatório	O que é
`count`	`integer`	Não	—
`items_without_dates`	`integer`	Não	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`	Não	—
`entries`	`GitHubProjectRoadmapEntry[]`	Não	—

Erros que este endpoint pode retornar

401 · 403 · 422