board-github
GET /v1/board-github/links
The GitHub Projects this organisation has connected.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/board-github/links \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
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.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
board_id (query) | string | いいえ | Only links surfaced alongside this board. |
cursor (query) | string | いいえ | Opaque cursor from a previous page's page.next_cursor. |
limit (query) | integer | いいえ | Maximum items to return (page size). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
data | GitHubProjectLink[] | はい | — |
page | PageMeta | はい | — |
このエンドポイントが返すエラー
401 · 403