agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
인증
Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.
이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 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