agency-board
GET /v1/agency/boards/{boardId}
One board, with its columns, cards and labels.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
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