public

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

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

כל נקודות הקצה מסוג public

כל תיעוד המפתחים

אימות

נקודת קצה זו היא ציבורית. היא אינה דורשת שורת פרטי זיהוי ואינה דורשת ארגון – זהו המידע שאתרי השיווק ומנועי התשובות מבוססי ה-AI שלנו קוראים.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-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…

תשובה

שםסוגנדרשמה זה
statusstring<ok>כן
roleAgencyBoardInviteRoleכן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_accountbooleanכן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_bystringכן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_inSharedBoardSignInכן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…
boardSharedAgencyBoardDetailכן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