board-github

GET /v1/board-github/links/{linkId}/items

The items on a connected project.

Tutti gli endpoint board-github

Autenticazione

Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId}/items \
  -H "Authorization: Bearer zdk_live_…"

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

Issues, pull requests and draft items, each with its field values already resolved to both a stored value and a display string, so a board can render a column without a second lookup per card. Archived items are excluded unless `include_archived` is set: GitHub keeps them on the project for ever and a board that showed them would grow without bound while looking like work in progress.

Parametri

NomeTipoObbligatorioChe cos'è
linkId (path)stringThe GitHub Projects connection.
include_archived (query)booleanNoAn item removed from the project on GitHub is marked archived here rather than deleted, so a board card linked to it keeps its link and its history.
cursor (query)stringNoOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerNoMaximum items to return (page size).

Risposta

NomeTipoObbligatorioChe cos'è
dataGitHubProjectItem[]
pagePageMeta

Errori che questo endpoint può restituire

401 · 403 · 404