---
title: "Whether this workspace's learned routes are shared to the public registry, and why"
method: GET
path: "/api/v1/workspace/sharing"
tags: ["Account"]
---

# Whether this workspace's learned routes are shared to the public registry, and why

`GET /api/v1/workspace/sharing`

## Request

- Base URL: `https://unbrowse.ai`
- URL: `https://unbrowse.ai/api/v1/workspace/sharing`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://unbrowse.ai/authorize`, token URL `https://unbrowse.ai/oauth/token`, scopes: `unbrowse`)
  - HTTP bearer

Acts on the workspace of the API key (or sign-in) making the call. Free workspaces share by default; a workspace that has ever paid is private by default and shares only after opting in. Run results and inputs are never published.

## Response `200`

The effective setting

- Sharing
  - `workspaceId` string, required
  - `shareLearned` boolean, required: Effective: whether a learned public read-only route is shared after its first verified run.
  - `explicit` boolean, nullable: What the workspace set; null when it never chose (the plan default applies).
  - `paid` boolean, required: The workspace has paid credits or a completed purchase.
  - `reason` string, required
  - `shared` integer: Routes this workspace has shared so far.
  - `published` string: What sharing publishes: the scrubbed route only, never run results or inputs.

## Other responses

- `400`: An error
- `401`: Missing or invalid credentials. The WWW-Authenticate header names the protected-resource metadata.
- `402`: An error
- `404`: An error
- `429`: An error

---

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