agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
boardId (path) | Uuid | Так | Project board ID (UUIDv7). |
include_archived (query) | boolean | Ні | 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… |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
id | Uuid | Так | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Так | The agency that owns this board. |
client_org_id | string | Ні | 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 | Ні | 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 | Так | — |
description | string | Ні | — |
archived_at | string | Ні | — |
open_question_count | integer | Ні | — |
created_at | string | Так | — |
updated_at | string | Ні | — |
created_by | AgencyBoardActor | Ні | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | Ні | 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[] | Ні | — |
cards | AgencyBoardCard[] | Ні | — |
labels | AgencyBoardLabel[] | Ні | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404