board-github
GET /v1/board-github/links/{linkId}
One connection, with its WIP report and its open notices.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId} \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
The connection screen's whole payload in one call: the project, its fields with their options, the per-status counts against any WIP limits, and the notices GitHub does not raise — overdue items, items nothing has touched for a fortnight, and columns over their limit. `last_synced_at` and `last_attempted_at` are both returned and are different questions: a connection GitHub keeps refusing has a recent attempt and a stale success, and reporting only the first would show a healthy timestamp on a connection that has been broken for a week.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
linkId (path) | string | بله | The GitHub Projects connection. |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
id | string | خیر | — |
board_id | string | خیر | — |
auth_kind | GitHubAuthKind | خیر | `app` is the Zinn® GitHub App installation — per-repository scope the customer chooses on GitHub's own screen, revocable by them in one click, belonging to their organisation ra… |
installation_id | string | خیر | Public — it appears in the customer's own install URL — and showing it is what lets them confirm on GitHub that they are looking at the right installation. |
has_stored_token | boolean | خیر | Whether a token is held in Vault for this connection. The token itself is never returned. |
project_node_id | string | خیر | — |
project_number | integer | خیر | — |
owner_login | string | خیر | — |
owner_type | string | خیر | — |
title | string | خیر | — |
short_description | string | خیر | — |
closed | boolean | خیر | — |
public | boolean | خیر | — |
direction | GitHubSyncDirection | خیر | `both` is the default (owner ruling, 2026-09-03: a new connection is read-write immediately). `pull` is the honest remedy when a push keeps being refused. |
notice_delivery | GitHubNoticeDelivery | خیر | Where a connection's overdue / gone-quiet / over-WIP notices are allowed to go. Both values raise the same notices and both render them on the board — the difference is delivery… |
views | object[] | خیر | The project's saved views on GitHub, replaced whole on every read so a view deleted there disappears here rather than lingering as a link GitHub answers with a 404. Rendered as… |
url | string | خیر | — |
webhook_state | GitHubWebhookState | خیر | Whether GitHub pushes changes at us, and if not, whose move it is. **Three outcomes and not a boolean.** `automatic` — we created the organisation webhook. `manual` — GitHub wou… |
last_synced_at | string | خیر | When a sync last SUCCEEDED. What the staleness alarm fires off. |
last_attempted_at | string | خیر | When a sync was last ATTEMPTED, stamped for every connection the sweep reaches before the result is read. Two columns rather than one: a cursor only a successful pass advanced w… |
last_error | string | خیر | — |
created_at | string | خیر | — |
fields | GitHubProjectField[] | خیر | The project's fields, with their single-select options and any work-in-progress limits set on them. Returned with the connection rather than fetched separately, because a board… |
wip | GitHubProjectStatusCount[] | خیر | — |
notices | GitHubProjectNotice[] | خیر | — |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404