board-github
GET /v1/board-github/links
The GitHub Projects this organisation has connected.
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 \
-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
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
board_id (query) | string | Non | Only links surfaced alongside this board. |
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 | GitHubProjectLink[] | Oui | — |
page | PageMeta | Oui | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403