agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
boardId (path) | Uuid | Ano | Project board ID (UUIDv7). |
include_archived (query) | boolean | Ne | 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… |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Ano | The agency that owns this board. |
client_org_id | string | Ne | 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 | Ne | 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 | Ano | — |
description | string | Ne | — |
archived_at | string | Ne | — |
open_question_count | integer | Ne | — |
created_at | string | Ano | — |
updated_at | string | Ne | — |
created_by | AgencyBoardActor | Ne | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | Ne | 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[] | Ne | — |
cards | AgencyBoardCard[] | Ne | — |
labels | AgencyBoardLabel[] | Ne | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404