agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
Kimlik Doğrulama
Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.
Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
boardId (path) | Uuid | Evet | Project board ID (UUIDv7). |
include_archived (query) | boolean | Hayır | 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… |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Evet | The agency that owns this board. |
client_org_id | string | Hayır | 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 | Hayır | 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 | Evet | — |
description | string | Hayır | — |
archived_at | string | Hayır | — |
open_question_count | integer | Hayır | — |
created_at | string | Evet | — |
updated_at | string | Hayır | — |
created_by | AgencyBoardActor | Hayır | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | Hayır | 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[] | Hayır | — |
cards | AgencyBoardCard[] | Hayır | — |
labels | AgencyBoardLabel[] | Hayır | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404