agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
Authentication
Send an API key as a bearer token. The endpoint checks agency.board.view; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
boardId (path) | Uuid | Yes | Project board ID (UUIDv7). |
include_archived (query) | boolean | No | 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… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Yes | The agency that owns this board. |
client_org_id | string | No | 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 | No | 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 | Yes | — |
description | string | No | — |
archived_at | string | No | — |
open_question_count | integer | No | — |
locked | object | No | Why this board cannot be opened right now — the owning organisation's plan no longer includes project boards — as the same MACHINE CODE and plan name create_blocked carries, or… |
created_at | string | Yes | — |
updated_at | string | No | — |
created_by | AgencyBoardActor | No | Who created the board. null if that account no longer exists. |
updated_by | AgencyBoardActor | No | 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… |
columns | AgencyBoardColumn[] | No | — |
cards | AgencyBoardCard[] | No | — |
labels | AgencyBoardLabel[] | No | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
Errors this endpoint can return
401 · 403 · 404