notices
GET /v1/notices
The notices to show at the top of this screen.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/notices \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
docs/87. What the platform is currently telling this customer, on this route, in their language — already sanitised, already localised. ⛔ No permission key. Reading the notices aimed at you is not a privilege: gating it would mean a member whose role happens to lack org.read never learns their card needs re-adding. The audience is the scope — a notice reaches an organization only if it is explicitly everyone or that org is named in its audience. An untargeted notice reaches nobody, never everybody. Exactly one of body_html and body_i18n_key is populated (a database constraint). body_html is operator-authored and safe to render as HTML; body_i18n_key + body_params are rendered from the SPA's own catalogue.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
route (query) | string | いいえ | The dashboard path being rendered, e.g. /billing/invoices. Defaults to /. A query string is ignored, so a notice aimed at /billing does not vanish when the screen adds a tab. |
org_id (query) | string | いいえ | Narrow to one organization. Omitted, the caller's whole accessible subtree is considered, so a reseller admin sees a notice aimed at a client org they manage. An id outside that… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
data | Notice[] | はい | — |
このエンドポイントが返すエラー
401 · 429