board-github
GET /v1/board-github/links/{linkId}/items
The items on a connected project.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId}/items \
-H "Authorization: Bearer zdk_live_…"Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
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.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
linkId (path) | string | Ja | The GitHub Projects connection. |
include_archived (query) | boolean | Nein | 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 | Nein | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Nein | Maximum items to return (page size). |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
data | GitHubProjectItem[] | Ja | — |
page | PageMeta | Ja | — |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404