public
GET /v1/public/boards/shared/{shareToken}
Open a board someone shared with you. No account needed.
Authentification
Cet point de terminaison est public. Il ne nécessite aucun identifiant ni aucune organisation : c'est ce que notre propre site marketing et nos moteurs de réponse IA lisent.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/public/boards/shared/{shareToken}Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
shareToken (path) | string | Oui | 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… |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
status | string<ok> | Oui | — |
role | AgencyBoardInviteRole | Oui | 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 | Oui | 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 | Oui | 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 | Oui | 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 | Oui | 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. |
Erreurs que cet point de terminaison peut renvoyer
404 · 410 · 429