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 консолінде ашыңыз
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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… |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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