agency-board
GET /v1/agency/client/boards/{boardId}
The client's view of one board.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/agency/client/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
Returns **only** what the agency shared: columns marked client-visible, cards that are client-visible **and** sit in such a column, client-visible comments and attachments on those cards, and every question asked on them. ⛔ Anything not shared is absent from the response, not merely hidden in the UI. The payload is built by a hand-written projection with a test pinning its exact field set — it carries no assignee, no author identity beyond "from the client or not", no internal ids and no WIP limits.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
boardId (path) | Uuid | Да | Project board ID (UUIDv7). |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Да | — |
description | string | Нет | — |
open_question_count | integer | Нет | — |
intake_column_id | string | Нет | — |
columns | SharedAgencyBoardColumn[] | Да | — |
cards | SharedAgencyBoardCard[] | Да | — |
comments | SharedAgencyBoardComment[] | Нет | — |
questions | SharedAgencyBoardQuestion[] | Нет | — |
attachments | SharedAgencyBoardAttachment[] | Нет | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404