agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
Autentifikacija
Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.
Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Parametri
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
boardId (path) | Uuid | Da | Project board ID (UUIDv7). |
include_archived (query) | boolean | Ne | 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… |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Da | The agency that owns this board. |
client_org_id | string | Ne | 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_name | string | Ne | 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… |
name | string | Da | — |
description | string | Ne | — |
archived_at | string | Ne | — |
open_question_count | integer | Ne | — |
created_at | string | Da | — |
updated_at | string | Ne | — |
created_by | AgencyBoardActor | Ne | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | Ne | 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… |
columns | AgencyBoardColumn[] | Ne | — |
cards | AgencyBoardCard[] | Ne | — |
labels | AgencyBoardLabel[] | Ne | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
Pogreške koje ova krajnja točka može vratiti
401 · 403 · 404