agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
Pagpapatotoo
Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.
Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
boardId (path) | Uuid | Oo | Project board ID (UUIDv7). |
include_archived (query) | boolean | Hindi | 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… |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
id | Uuid | Oo | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Oo | The agency that owns this board. |
client_org_id | string | Hindi | 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 | Hindi | 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 | Oo | — |
description | string | Hindi | — |
archived_at | string | Hindi | — |
open_question_count | integer | Hindi | — |
created_at | string | Oo | — |
updated_at | string | Hindi | — |
created_by | AgencyBoardActor | Hindi | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | Hindi | 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[] | Hindi | — |
cards | AgencyBoardCard[] | Hindi | — |
labels | AgencyBoardLabel[] | Hindi | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404