agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
Autentificare
Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.
Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
boardId (path) | Uuid | Da | Project board ID (UUIDv7). |
include_archived (query) | boolean | Nu | 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… |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Da | The agency that owns this board. |
client_org_id | string | Nu | 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 | Nu | 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 | Da | — |
description | string | Nu | — |
archived_at | string | Nu | — |
open_question_count | integer | Nu | — |
created_at | string | Da | — |
updated_at | string | Nu | — |
created_by | AgencyBoardActor | Nu | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | Nu | 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[] | Nu | — |
cards | AgencyBoardCard[] | Nu | — |
labels | AgencyBoardLabel[] | Nu | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
Erori pe care le poate returna acest punct final
401 · 403 · 404