agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
المصادقة
أرسل مفتاح واجهة برمجة التطبيقات (API) كرمز حامل (bearer token). لا يحدد نقطة النهاية هذه إذنًا محددًا في المواصفات، لذا امنح مفتاحك الحد الأدنى الذي محتاجه وتحقق من الاستجابة بدلاً من الافتراض.
لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.
جربه الآن
استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API
المعلمات
| الاسم | النوع | مطلوب | ما هو هذا |
|---|---|---|---|
boardId (path) | Uuid | نعم | Project board ID (UUIDv7). |
include_archived (query) | boolean | لا | Include archived cards in `cards`. ⛔ This parameter was on `/cards` from the day the board shipped and NOT here — and this is the endpoint the board screen calls, so an archived… |
الاستجابة
| الاسم | النوع | مطلوب | ما هو هذا |
|---|---|---|---|
id | Uuid | نعم | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | نعم | The agency that owns this board. |
client_org_id | string | لا | The client organisation this board's work is for, if any. This is what authorises a client's read — never the org tree, because "is a descendant of the agency" is a weaker claim… |
client_org_name | string | لا | That client organisation's name, resolved by the engine. `client_org_id` set with this `null` is a real state and not an error — the board names a client the caller may not read… |
name | string | نعم | — |
description | string | لا | — |
archived_at | string | لا | — |
open_question_count | integer | لا | — |
created_at | string | نعم | — |
updated_at | string | لا | — |
created_by | AgencyBoardActor | لا | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | لا | Who last changed the board itself — its name, description or client organisation. ⛔ NOT "who last touched anything on it": that is the activity feed. It moves exactly when `upda… |
columns | AgencyBoardColumn[] | لا | — |
cards | AgencyBoardCard[] | لا | — |
labels | AgencyBoardLabel[] | لا | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه
401 · 403 · 404