agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
Autentifikimi
Drgoni një çelës API si një token mbajtës. Ky pikëndalim nuk specifikon një leje specifike në specifikim, prandaj jepini çelësit tuaj minimumin e nevojshëm dhe kontrolloni përgjigjen në vend që të supozoni.
Ky pikëndalim nuk pranon id të organizatës. Çelësi juaj tashmë identifikon organizatën së cilës i përket dhe përgjigjja kufizohet vetëm për atë.
Provoje
Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së
Parametrat
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
boardId (path) | Uuid | Po | Project board ID (UUIDv7). |
include_archived (query) | boolean | Jo | 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… |
Përgjigja
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
id | Uuid | Po | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Po | The agency that owns this board. |
client_org_id | string | Jo | 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 | Jo | 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 | Po | — |
description | string | Jo | — |
archived_at | string | Jo | — |
open_question_count | integer | Jo | — |
created_at | string | Po | — |
updated_at | string | Jo | — |
created_by | AgencyBoardActor | Jo | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | Jo | 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[] | Jo | — |
cards | AgencyBoardCard[] | Jo | — |
labels | AgencyBoardLabel[] | Jo | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
Gabimet që ky pikëndalim mund të kthejë
401 · 403 · 404