agency-board

GET /v1/agency/boards/{boardId}

One board, with its columns, cards and labels.

Vituo vyote vya agency-board

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Sehemu hii ya mwisho haitaji ruhusa maalum katika maelezo, kwa hivyo ipe ufunguo wako kiwango cha chini kabisa kinachohitajika na uangalie jibu badala ya kukisia.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Vigezo

JinaAinaInayohitajikaKilicho hiki
boardId (path)UuidNdiyoProject board ID (UUIDv7).
include_archived (query)booleanHapanaInclude 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…

Majibu

JinaAinaInayohitajikaKilicho hiki
idUuidNdiyoUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidNdiyoThe agency that owns this board.
client_org_idstringHapanaThe 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_namestringHapanaThat 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…
namestringNdiyo
descriptionstringHapana
archived_atstringHapana
open_question_countintegerHapana
created_atstringNdiyo
updated_atstringHapana
created_byAgencyBoardActorHapanaWho created the board. `null` if that account no longer exists.
updated_byAgencyBoardActorHapanaWho 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…
columnsAgencyBoardColumn[]Hapana
cardsAgencyBoardCard[]Hapana
labelsAgencyBoardLabel[]HapanaThe board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these.

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404