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