agency-board

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

The client's view of one board.

Alle agency-board Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X GET https://api.zinndigital.com/v1/agency/client/boards/{boardId} \
  -H "Authorization: Bearer zdk_live_…"

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

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.

Parameter

NameTypErforderlichWas es ist
boardId (path)UuidJaProject board ID (UUIDv7).

Antwort

NameTypErforderlichWas es ist
idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringJa
descriptionstringNein
open_question_countintegerNein
intake_column_idstringNein
columnsSharedAgencyBoardColumn[]Ja
cardsSharedAgencyBoardCard[]Ja
commentsSharedAgencyBoardComment[]Nein
questionsSharedAgencyBoardQuestion[]Nein
attachmentsSharedAgencyBoardAttachment[]Nein

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404