public
GET /v1/public/boards/shared/{shareToken}
Open a board someone shared with you. No account needed.
認証
このエンドポイントは公開されています。認証情報や組織情報は不要で、当社のマーケティングサイトやAI回答エンジンが読み取っているものと同じです。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/public/boards/shared/{shareToken}ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Unauthenticated. The token in the path is the whole authorisation: whoever holds it holds the grant, which is what makes the link pasteable into a channel we do not control. What comes back is the client projection — the same field-listed view the agency's client gets in their own console, and literally the same code path. Anything the agency marked internal is excluded at the queryset, not in the UI. ⭐ sign_in names the brand whose board this is, resolved by walking up the organisation tree, so a reseller's client is sent to the reseller's branded login and never to ours. requires_account answers "must I register?" as data, so a client never has to work out the rule from the role name.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
shareToken (path) | string | はい | The share link's bearer token, as it appears in the URL somebody pasted. This is a credential: 256 bits from a CSPRNG behind a zbi_ prefix, and whoever holds it holds the… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
status | string<ok> | はい | — |
role | AgencyBoardInviteRole | はい | What a share link grants. viewer is link-only: it creates no board seat and no organisation membership, because it grants no identity — it is read-through-the-token, which… |
requires_account | boolean | はい | Whether the visitor must sign in before they can do anything. false for a viewer link — they can read this board with no Zinn® account at all. |
shared_by | string | はい | The brand whose board this is, resolved by walking up the organisation tree — so a reseller's client is told the reseller's name, not the client org's and not ours. |
sign_in | SharedBoardSignIn | はい | Where this board's visitors sign in, and under whose name. ⛔⛔ Computed by the engine from the board, because nothing downstream knows whose board it is: the dashboard reads one… |
board | SharedAgencyBoardDetail | はい | The client projection — the same field-listed view the agency's own client gets, produced by the same code. Anything marked internal is excluded at the queryset. |
このエンドポイントが返すエラー
404 · 410 · 429