board-github
GET /v1/board-github/links/{linkId}/items
The items on a connected project.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId}/items \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему 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