---
title: "List the people a capsule, Type or Collection is shared with"
method: GET
path: "/api/preview/grants"
tags: ["share"]
---

# List the people a capsule, Type or Collection is shared with

`GET /api/preview/grants`

## 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/grants`
- 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', required: The kind of resource: a capsule, a Type or a Collection.
- `resourceId` string, required: UUID v4 string
- `ws` string: Optional workspace context. Validated (a workspace you cannot reach is a 404), but the answer is always the same as without it: these reads are about the resource or about you, not about a workspace.

## Response `200`

Successful response

- object
  - `grants` object[], required
    - `access` 'view' | 'edit', required: `view` lets the person read it; `edit` also lets them change a capsule's title, body and fields.
    - `created_at` string, required
    - `email` string, nullable, required
    - `id` string, required: UUID v4 string
    - `name` string, nullable, required
    - `pending` boolean, required: True until the person first opens Shared with me (shown as "Invited, not yet joined").
    - `resource_id` string, required: UUID v4 string
    - `resource_type` 'capsule' | 'type' | 'collection', required: The kind of resource: a capsule, a Type or a Collection.
    - `username` string, nullable, required

## Changes

- **2026-10-19** `5778844d1f9e`: 1 info
  - added the new optional `query` request parameter `ws`
- **2026-10-09** `c7729725d527`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/symbol/apis/symbol-api/changes/api/preview/grants/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)