agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
boardId (path) | Uuid | Igen | Project board ID (UUIDv7). |
include_archived (query) | boolean | Nem | 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… |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Igen | The agency that owns this board. |
client_org_id | string | Nem | 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 | Nem | 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 | Igen | — |
description | string | Nem | — |
archived_at | string | Nem | — |
open_question_count | integer | Nem | — |
created_at | string | Igen | — |
updated_at | string | Nem | — |
created_by | AgencyBoardActor | Nem | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | Nem | 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[] | Nem | — |
cards | AgencyBoardCard[] | Nem | — |
labels | AgencyBoardLabel[] | Nem | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404