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