---
title: "Read share settings"
method: GET
path: "/reports/{id}/share"
tags: ["Sharing"]
---

# Read share settings

`GET /reports/{id}/share`

## Request

- Base URL: `https://commareports.com/api/v1`
- URL: `https://commareports.com/api/v1/reports/{id}/share`
- Auth: HTTP bearer

Current visibility, link permission, whether a link password is set, staged-publishing state, and embed settings. Scope: `reports:read`.

## Response `200`

Share settings.

- ShareSettings
  - `id` string, uuid, required
  - `visibility` 'private' | 'team' | 'registered' | 'public' | 'domain', required
  - `public_permission` 'none' | 'view' | 'comment' | 'edit', required
  - `allowed_email_domains` string[]: Email domains allowed to view. Empty unless visibility is 'domain'.
  - `password_set` boolean, required
  - `show_approved_only` boolean, required
  - `approved_revision_id` string, uuid, nullable
  - `allowed_embed_origins` string[], required
  - `embed_url` string, nullable, required: `/embed/{id}`, or null when embedding is off.
  - `embed_snippet` string, nullable, required: Markup to paste into the host page, or null when embedding is off. Renders only while the report is public, its link permission isn't `none`, and it has no share password.
  - `updated_at` string, date-time, required
  - `share_url` string, required

## Other responses

- `401`: Missing, invalid, revoked, or expired token.
- `403`: Token missing the required scope, or no access to the resource.
- `404`: Resource not found (also returned instead of 403 where existence must not leak).
- `429`: Rate limit exceeded. Rate limit: per-token sliding window (plan-aware — Free 60 req/min, Pro 600, Team/Enterprise 6000 by default); 429 responses carry a Retry-After header.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/commareports/apis/comma-api.md) · [All operations](https://skmtc.dev/commareports/apis/comma-api/llms.txt) · [OpenAPI document](https://skmtc.dev/commareports/apis/comma-api/revisions/cd5263522ade?raw)