agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
אימות
שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-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