board-github
GET /v1/board-github/links/{linkId}/items
The items on a connected project.
Authentication
Send an API key as a bearer token. The endpoint checks agency.board.view; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId}/items \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the 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
| Name | Type | Required | What it is |
|---|---|---|---|
linkId (path) | string | Yes | The GitHub Projects connection. |
include_archived (query) | boolean | No | 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 | No | Opaque cursor from a previous page's page.next_cursor. |
limit (query) | integer | No | Maximum items to return (page size). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | GitHubProjectItem[] | Yes | — |
page | PageMeta | Yes | — |
Errors this endpoint can return
401 · 403 · 404