agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Điểm cuối này không nêu rõ quyền cụ thể trong thông số kỹ thuật, vì vậy hãy cấp cho khóa của bạn quyền tối thiểu cần thiết và kiểm tra phản hồi thay vì phỏng đoán.
Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
boardId (path) | Uuid | Có | Project board ID (UUIDv7). |
include_archived (query) | boolean | Không | 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… |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
id | Uuid | Có | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Có | The agency that owns this board. |
client_org_id | string | Không | 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 | Không | 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 | Có | — |
description | string | Không | — |
archived_at | string | Không | — |
open_question_count | integer | Không | — |
created_at | string | Có | — |
updated_at | string | Không | — |
created_by | AgencyBoardActor | Không | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | Không | 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[] | Không | — |
cards | AgencyBoardCard[] | Không | — |
labels | AgencyBoardLabel[] | Không | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404