public

GET /v1/public/boards/shared/{shareToken}

Open a board someone shared with you. No account needed.

Wszystkie punkty końcowe public

Uwierzytelnianie

Ten punkt końcowy jest publiczny. Nie wymaga żadnych poświadczeń ani organizacji — to z niego korzysta nasza własna strona marketingowa oraz silniki odpowiedzi AI.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

curl -X GET https://api.zinndigital.com/v1/public/boards/shared/{shareToken}

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

**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.

Parametry

NazwaTypWymaganeCo to jest
shareToken (path)stringTakThe 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…

Odpowiedź

NazwaTypWymaganeCo to jest
statusstring<ok>Tak
roleAgencyBoardInviteRoleTakWhat 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_accountbooleanTakWhether 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_bystringTakThe **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_inSharedBoardSignInTakWhere 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…
boardSharedAgencyBoardDetailTakThe 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.

Błędy, które ten punkt końcowy może zwrócić

404 · 410 · 429