agency-board

GET /v1/agency/client/boards/{boardId}

The client's view of one board.

All agency-board endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

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

NameTypeRequiredWhat it is
boardId (path)UuidYesProject board ID (UUIDv7).

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringYes
descriptionstringNo
open_question_countintegerNo
intake_column_idstringNo
columnsSharedAgencyBoardColumn[]Yes
cardsSharedAgencyBoardCard[]Yes
commentsSharedAgencyBoardComment[]No
questionsSharedAgencyBoardQuestion[]No
attachmentsSharedAgencyBoardAttachment[]No

Errors this endpoint can return

401 · 403 · 404