agency-board

GET /v1/agency/boards/{boardId}

One board, with its columns, cards and labels.

Gbogbo àwọn agency-board endpoints

Ìfàṣẹ́pọ̀

Fi bọ́kì kọ́kọ́ (bearer token) ránṣẹ́ gẹ́gẹ́ bí àmì ìdánimọ̀ API. Ibùdó yìí kò sọ àṣẹ pàtó kan nínú àlàyé rẹ̀, nítorí náà fún kọ́kọ́ rẹ̀ ní ohun tó kéré jù lọ tí ó nílò kí o sì ṣàyẹ̀wò ìdáhùn náà dípò kí o kàn rò ó.

Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

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

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn ìpìlẹ̀

OrúkọIruTí a nílòKini o jẹ
boardId (path)UuidBẹẹniProject board ID (UUIDv7).
include_archived (query)booleanBẹẹkọ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…

Idahun

OrúkọIruTí a nílòKini o jẹ
idUuidBẹẹniUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidBẹẹniThe agency that owns this board.
client_org_idstringBẹẹkọ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_namestringBẹẹkọ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…
namestringBẹẹni
descriptionstringBẹẹkọ
archived_atstringBẹẹkọ
open_question_countintegerBẹẹkọ
created_atstringBẹẹni
updated_atstringBẹẹkọ
created_byAgencyBoardActorBẹẹkọWho created the board. `null` if that account no longer exists.
updated_byAgencyBoardActorBẹẹkọ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 `upda…
columnsAgencyBoardColumn[]Bẹẹkọ
cardsAgencyBoardCard[]Bẹẹkọ
labelsAgencyBoardLabel[]BẹẹkọThe board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these.

Awọn aṣiṣe ti ibudo ipari yii le da pada

401 · 403 · 404