---
title: "GET /api/document/public"
method: GET
path: "/api/document/public"
tags: ["/api/document"]
---

# GET /api/document/public

`GET /api/document/public`

List all Documents that have public links.

  Returns a sequence of Documents that have been publicly shared. Each Document includes its `:id`, `:name`,
  and `:public_uuid`. Documents are only actually accessible via the public endpoint if public sharing is
  currently enabled. Archived Documents are excluded from the results.

  This endpoint is used to populate the public links listing in the Admin settings UI.

  Requires superuser permissions. Public sharing must be enabled via the `enable-public-sharing` setting.

## Response `2XX`

Successful response

- object[]
  - `id` integer, required — value must be an integer greater than zero.
  - `name` string, required
  - `public_uuid` string, required — value must be a valid UUID.

## Other responses

- `4XX` — Client error response
- `5XX` — Server error response

---

[API](https://skmtc.net/metabase/apis/metabase-api.md) · [All operations](https://skmtc.net/metabase/apis/metabase-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/metabase/metabase-api/revisions/08b5a2bafb4f/schema)