---
title: "Read a capsule's visibility, the links it is reachable through, how many people it is shared with, and your own access to it"
method: GET
path: "/api/preview/capsules/{id}/permissions"
tags: ["share"]
---

# Read a capsule's visibility, the links it is reachable through, how many people it is shared with, and your own access to it

`GET /api/preview/capsules/{id}/permissions`

## 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/capsules/{id}/permissions`
- 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`

## Path parameters

- `id` string, required: UUID v4 string

## Response `200`

Successful response

- object
  - `effective` object, required
    - `can_update` boolean, required
  - `in_library_share` boolean, required
  - `organizationId` string, nullable, required
  - `organizationName` string, nullable, required
  - `reachableThrough` object[], required
    - `id` string, required
    - `kind` 'type' | 'collection' | 'link' | 'project', required
    - `name` string, required
    - `slug` string, required
    - `visibility` 'link' | 'public', required
  - `sharedWithPeople` object, nullable: How many people the capsule is shared with, for a caller who may manage its people. Null for a caller who may not; absent when the count could not be read.
    - `archived` boolean, required: True while the capsule is archived. 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 the capsule is shared with, directly or through its Type or Collection. A pending invite counts.
    - `direct` integer, required: Of those, how many it is shared with directly.
    - `viewerIsOwner` boolean, required: Whether you own the capsule; false when you manage it as an organization owner or Admin.
  - `shared_since` string, nullable, required
  - `visibility` 'self' | 'link' | 'public' | 'org_view' | 'org_edit', required

## Changes

- **2026-10-27** `3a2c4ebeab51`: 1 info
  - added the optional property `sharedWithPeople` 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/capsules/:id/permissions/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)