agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
Autenticazione
Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
boardId (path) | Uuid | Sì | Project board ID (UUIDv7). |
include_archived (query) | boolean | No | 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… |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
id | Uuid | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Sì | The agency that owns this board. |
client_org_id | string | No | 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 | No | 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 | Sì | — |
description | string | No | — |
archived_at | string | No | — |
open_question_count | integer | No | — |
created_at | string | Sì | — |
updated_at | string | No | — |
created_by | AgencyBoardActor | No | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | No | 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[] | No | — |
cards | AgencyBoardCard[] | No | — |
labels | AgencyBoardLabel[] | No | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
Errori che questo endpoint può restituire
401 · 403 · 404