---
title: "Read a capsule, Type, Collection or project's visibility, public address, live link count and how many people it is shared with"
method: GET
path: "/api/preview/share/visibility"
tags: ["share"]
---

# Read a capsule, Type, Collection or project's visibility, public address, live link count and how many people it is shared with

`GET /api/preview/share/visibility`

## Request

- Base URL: `https://symbol.chat` (the document declares no server; this is the origin it was published from)
- URL: `https://symbol.chat/api/preview/share/visibility`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Secure-next-auth.session-token`
  - OAuth 2
    - Authorization code: `https://mcp.symbol.chat/authorize`
    - Token URL: `https://mcp.symbol.chat/token`

## Query parameters

- `resourceType` 'capsule' | 'type' | 'collection' | 'project', required: The kind of resource.
- `resourceId` string, required: The capsule, Type, Collection or project id.

## Response `200`

Successful response

- object
  - `listing_url` string, uri, nullable, required
  - `live_link_count` integer, required
  - `publishing` object
    - `blocked_reason` 'username_required' | 'email_unverified' | 'account_flagged' | 'org_policy' | 'public_profile_off', nullable, required
    - `eligible` boolean, required
    - `has_username` boolean, required
    - `public_profile_enabled` boolean, required
  - `shared_with_people` object, nullable: How many people it is shared with, for a caller who may manage its people. Null for a caller who may not; absent for a project, or when the count could not be read.
    - `archived` boolean, required: True for an archived capsule. Its people have no access through their shares until it is restored, except on a team capsule its whole organization reads (`org_view`, `org_edit`), which members still open.
    - `count` integer, required: Distinct people it is shared with, through it or (for a capsule) its Type or Collection. A pending invite counts.
    - `direct` integer, required: Of those, how many it is shared with directly.
    - `viewer_is_owner` boolean, required: Whether you own it; false when you manage it as an organization owner or Admin.
  - `vanity_url` string, uri, nullable, required
  - `visibility` 'self' | 'link' | 'public' | 'org_view' | 'org_edit', required

## Changes

- **2026-10-27** `3a2c4ebeab51`: 1 info
  - added the optional property `shared_with_people` to the response with the `200` status
- **2026-10-19** `5778844d1f9e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/symbol/apis/symbol-api/changes/api/preview/share/visibility/get.md)

---

[API](https://skmtc.dev/symbol/apis/symbol-api.md) - [All operations](https://skmtc.dev/symbol/apis/symbol-api/llms.txt) - [OpenAPI document](https://skmtc.dev/symbol/apis/symbol-api/revisions/3a2c4ebeab51?raw)