board-github
GET /v1/board-github/links
The GitHub Projects this organisation has connected.
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.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
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/links \
-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
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.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
board_id (query) | string | Não | Only links surfaced alongside this board. |
cursor (query) | string | Não | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Não | Maximum items to return (page size). |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
data | GitHubProjectLink[] | Sim | — |
page | PageMeta | Sim | — |
Erros que este endpoint pode retornar
401 · 403