agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
Autentikasi
Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.
Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
boardId (path) | Uuid | Ya | Project board ID (UUIDv7). |
include_archived (query) | boolean | Tidak | 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… |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Ya | The agency that owns this board. |
client_org_id | string | Tidak | 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 | Tidak | 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 | Ya | — |
description | string | Tidak | — |
archived_at | string | Tidak | — |
open_question_count | integer | Tidak | — |
created_at | string | Ya | — |
updated_at | string | Tidak | — |
created_by | AgencyBoardActor | Tidak | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | Tidak | 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[] | Tidak | — |
cards | AgencyBoardCard[] | Tidak | — |
labels | AgencyBoardLabel[] | Tidak | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404