agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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 | Не | — |
locked | object | Не | Why this board cannot be opened right now — the owning organisation's plan no longer includes project boards — as the same MACHINE CODE and plan name create_blocked carries, or… |
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… |
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