board-github
GET /v1/board-github/links/{linkId}/items
The items on a connected project.
Authenticatie
Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId}/items \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
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.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
linkId (path) | string | Ja | The GitHub Projects connection. |
include_archived (query) | boolean | Nee | 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 | Nee | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Nee | Maximum items to return (page size). |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
data | GitHubProjectItem[] | Ja | — |
page | PageMeta | Ja | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404