agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
تصدیقهویت
د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.
دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.
هڅه وکړئ
د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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