---
title: "Get file page payload"
method: GET
path: "/api/notebooks/{notebook}/attachments/{attachment}"
tags: ["notebook-attachment-controller"]
---

# Get file page payload

`GET /api/notebooks/{notebook}/attachments/{attachment}`

## Request

- Base URL: `` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/notebooks/{notebook}/attachments/{attachment}`
- Auth: none declared

Notebook chrome, folder trail through the file's folder, filename, and size.

## Path parameters

- `notebook` integer, required
- `attachment` integer, required

## Response `200`

OK

- NotebookAttachmentRealm: Notebook chrome plus one file for loading the file page: the shared realm sidebar with the folder trail from notebook root through the file's folder, the file's id and filename, and its size in bytes, and whether it is an image the page can show.
  - `notebookRealm` NotebookRealm, required: Notebook chrome: entity plus optional catalog hints (attached book, readonly), and optional container-owned readme markdown.
    - `notebook` Notebook, required
      - `id` integer, required
      - `notebookSettings` NotebookSettings, required
        - `skipMemoryTrackingEntirely` boolean
      - `creatorId` string
      - `name` string, required
      - `circle` Circle
        - `id` integer, required
        - `name` string, required
      - `description` string
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `readmeContent` string
    - `hasAttachedBook` boolean
    - `readonly` boolean
    - `readmeContent` string: Container-owned notebook readme markdown. Omitted when absent.
  - `ancestorFolders` FolderTrailSegment[]: Folders from notebook root outward; see each realm for trail semantics.
    - `id` integer, required
    - `name` string, required
  - `scopedReadmeContent` string: Full markdown of the container readme that supplies the nearest non-blank title_pattern (inner scope toward notebook root). Omitted when none applies.
  - `attachment` NotebookAttachmentListItem, required
    - `id` integer, required
    - `filename` string, required
  - `size` integer, required
  - `image` boolean, required
  - `references` NoteTopology[], required
    - `id` integer, required
    - `title` string, required
    - `createdAt` string, date-time
    - `updatedAt` string, date-time

## Changes

- **2026-09-28** `b03f330f8bab`: 1 info
  - added the required property `references` to the response with the `200` status
- **2026-09-28** `4803deb1cf63`: 1 breaking
  - removed the required property `references` from the response with the `200` status
- **2026-09-28** `b49e3d99ec19`: 1 info
  - added the required property `references` to the response with the `200` status
- **2026-09-27** `48ac5af2d6b6`: 1 breaking, 1 info
  - removed the required property `picture` from the response with the `200` status
  - added the required property `image` to the response with the `200` status
- **2026-09-27** `61cffca585d1`: 1 info
  - added the required property `picture` to the response with the `200` status

[Operation history](https://skmtc.dev/nerds-odd-e/apis/odd-e-open-api/changes/api/notebooks/:notebook/attachments/:attachment/get.md)

---

[API](https://skmtc.dev/nerds-odd-e/apis/odd-e-open-api.md) - [All operations](https://skmtc.dev/nerds-odd-e/apis/odd-e-open-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nerds-odd-e/apis/odd-e-open-api/revisions/193c5e89085a?raw)