board-github
GET /v1/board-github/links/{linkId}/items
The items on a connected project.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId}/items \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
linkId (path) | string | Oui | The GitHub Projects connection. |
include_archived (query) | boolean | Non | An 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) | string | Non | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Non | Maximum items to return (page size). |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
data | GitHubProjectItem[] | Oui | — |
page | PageMeta | Oui | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404