board-github
GET /v1/board-github/links
The GitHub Projects this organisation has connected.
Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/board-github/links \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
Each row carries `webhook_state`, which is the honest answer to *"is GitHub pushing changes at us, or are we polling?"*. It has three outcomes and not two: `automatic` (we created the hook), `manual` (GitHub would not let us, so the customer creates it and we hand them the URL and secret) and `failed`. `manual` is the commonest and is an instruction, not an error — creating an organisation webhook needs a permission most customers will not grant. The five-minute reconciliation sweep covers a project in every state, so this decides latency and never correctness.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
board_id (query) | string | Не | Only links surfaced alongside this board. |
cursor (query) | string | Не | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Не | Maximum items to return (page size). |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
data | GitHubProjectLink[] | Да | — |
page | PageMeta | Да | — |
Грешки, които този крайpoint може да върне
401 · 403