agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
boardId (path) | Uuid | Ja | Project board ID (UUIDv7). |
include_archived (query) | boolean | Nein | 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… |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Ja | The agency that owns this board. |
client_org_id | string | Nein | 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 | Nein | 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 | Ja | — |
description | string | Nein | — |
archived_at | string | Nein | — |
open_question_count | integer | Nein | — |
created_at | string | Ja | — |
updated_at | string | Nein | — |
created_by | AgencyBoardActor | Nein | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | Nein | 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[] | Nein | — |
cards | AgencyBoardCard[] | Nein | — |
labels | AgencyBoardLabel[] | Nein | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404