agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
प्रमाणन
एक बीयर टोकन के रूप में एक API कुंजी भेजें। यह एंडपॉइंट विनिर्देश में किसी विशिष्ट अनुमति का उल्लेख नहीं करता है, इसलिए अपनी कुंजी को न्यूनतम आवश्यकता दें और अनुमान लगाने के बजाय प्रतिक्रिया की जाँच करें।
यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।
इसे आज़माएँ
कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId} \
-H "Authorization: Bearer zdk_live_…"साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें
पैरामीटर
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
boardId (path) | Uuid | हाँ | Project board ID (UUIDv7). |
include_archived (query) | boolean | नहीं | 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… |
प्रतिक्रिया
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
id | Uuid | हाँ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | हाँ | The agency that owns this board. |
client_org_id | string | नहीं | 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 | नहीं | 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 | हाँ | — |
description | string | नहीं | — |
archived_at | string | नहीं | — |
open_question_count | integer | नहीं | — |
created_at | string | हाँ | — |
updated_at | string | नहीं | — |
created_by | AgencyBoardActor | नहीं | Who created the board. `null` if that account no longer exists. |
updated_by | AgencyBoardActor | नहीं | 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[] | नहीं | — |
cards | AgencyBoardCard[] | नहीं | — |
labels | AgencyBoardLabel[] | नहीं | The board's whole label vocabulary, so the card picker needs no second request. A board holds a handful of these. |
त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है
401 · 403 · 404