---
title: "Read a collection using its share-link capability."
method: GET
path: "/api/collections/shared/{token}"
tags: ["Agent Docs"]
---

# Read a collection using its share-link capability.

`GET /api/collections/shared/{token}`

## Request

- Base URL: `https://huggingbay.xyz`
- URL: `https://huggingbay.xyz/api/collections/shared/{token}`
- Auth: none required

No bearer token is needed, but the unguessable share token is required. Use a link its owner chose to share. This handler uses the production Postgres backend. The local JSON fixture backend may not serve this route.

**Inputs.** Path, query and header fields are listed below. No request body is required.

**Outputs.** See each status below for its media type, schema and headers. A missing record or unavailable capability is not a successful empty result.

**Errors.** API JSON failures use the documented response schema. Read code, message and next; retry only when the response allows it. Auth, invalid input and missing records need a caller change.

**Rate limits.** Public read budgets apply by client IP and route group. This operation can have a smaller route-specific budget. Read Retry-After on 429 or retryable 503 responses.

**Example setup.** Use an identifier returned by the matching list, search or create operation. Sample identifiers are not a promise that a record exists.

## Path parameters

- `token` string, required

## Response `200`

Read a collection using its share-link capability.

- object
  - `schemaVersion` 'hugging-bay.shared-collection.v1', required
  - `name` string, required
  - `description` string, required
  - `items` object[], required
    - `artifactId` string
    - `pinnedDigest` string, nullable
    - `note` string

## Other responses

- `404`: The shared collection was not found.
- `429`: Request budget exceeded. Wait for Retry-After.

---

[API](https://skmtc.dev/huggingbay/apis/hugging-bay-public-api.md) · [All operations](https://skmtc.dev/huggingbay/apis/hugging-bay-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/huggingbay/apis/hugging-bay-public-api/revisions/63c474bf0fe4?raw)
