agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.
Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
boardId (path) | Uuid | Tak | Project board ID (UUIDv7). |
include_archived (query) | boolean | Nie | 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… |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
id | Uuid | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Tak | The agency that owns this board. |
client_org_id | string | Nie | 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 | Nie | 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 | Tak | — |
description | string | Nie | — |
archived_at | string | Nie | — |
open_question_count | integer | Nie | — |
created_at | string | Tak | — |
updated_at | string | Nie | — |
created_by | AgencyBoardActor | Nie | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | Nie | 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[] | Nie | — |
cards | AgencyBoardCard[] | Nie | — |
labels | AgencyBoardLabel[] | Nie | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404