agency-board
GET /v1/agency/client/boards/{boardId}
The client's view of one board.
Authentication
Send an API key as a bearer token. The endpoint checks agency.board.client_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/client/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
Details
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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
boardId (path) | Uuid | Yes | Project board ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Yes | — |
description | string | No | — |
open_question_count | integer | No | — |
intake_column_id | string | No | — |
columns | SharedAgencyBoardColumn[] | Yes | — |
cards | SharedAgencyBoardCard[] | Yes | — |
comments | SharedAgencyBoardComment[] | No | — |
questions | SharedAgencyBoardQuestion[] | No | — |
attachments | SharedAgencyBoardAttachment[] | No | — |
Errors this endpoint can return
401 · 403 · 404