---
title: "Open a shared reading portrait"
method: GET
path: "/api/portrait/shared/{token}"
tags: ["portrait"]
---

# Open a shared reading portrait

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

## Request

- Base URL: `https://leafle.org` (the document declares no server; this is the origin it was published from)
- URL: `https://leafle.org/api/portrait/shared/{token}`
- Auth: none required

**Access: signed link.** The token in the path is the credential.

Returns the frozen, reader-approved snapshot. Omitted sections were not shared. Images may be relative media URLs or inline data URIs. Older snapshots remain unchanged; the schema describes newly created shares. An invalid, expired or revoked link returns 410.

## Path parameters

- `token` string, required

## Response `200`

Successful Response

- ShareSnapshot: A reader-approved portrait frozen when the link was created. Unshared sections are omitted. This describes newly created shares; older shares remain unchanged.
  - `name` string, required
  - `plate` string, nullable
  - `dingbats` string[], nullable
  - `accent_hex` string, nullable
  - `plate_w` integer, nullable
  - `plate_h` integer, nullable
  - `accent` string, required
  - `thesis` string, nullable
  - `prose` string, nullable
  - `threads` PortraitThread[], nullable
    - `id` string, required
    - `label` string, required
    - `weight` string, required
  - `favourite_authors` string[], nullable
  - `keystones` ShareBook[], nullable
    - `title` string, required
    - `author` string, required
    - `cover_url` string, nullable, required
  - `reading_lately` ShareBook[], nullable
    - `title` string, required
    - `author` string, required
    - `cover_url` string, nullable, required

## Other responses

- `410`: This link is no longer available.
- `422`: Validation Error

---

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