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

# Get folder page payload

`GET /api/notebooks/{notebook}/folders/{folder}`

## Request

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

Notebook chrome, folder metadata, parent folder id when nested, and optional folder readme content when present.

## Path parameters

- `notebook` integer, required
- `folder` integer, required

## Response `200`

OK

- FolderRealm: Notebook chrome plus folder row for loading the folder page: same shared realm sidebar as NoteRealm (without note-level fields), plus folder identity, optional parent folder id, and optional container-owned folder readme markdown.
  - `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.
  - `folder` Folder, required
    - `id` integer, required
    - `readmeContent` string
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `parentFolderId` integer: Parent folder id when nested; omitted at notebook root.
    - `name` string, required
  - `parentFolderId` integer: Parent folder id when this folder is nested; omitted at notebook root.
  - `readmeContent` string: Container-owned folder readme markdown. Omitted when absent.

## Changes

- **2026-09-27** `482412c3c1b0`: 4 breaking, 2 warning
  - the `ancestorFolders/items/name` response property's maxLength was unset from `512` for the response status `200`
  - the `ancestorFolders/items/name` response property's minLength was decreased from `1` to `0` for the response status `200`
  - removed the required property `ancestorFolders/items/createdAt` from the response with the `200` status
  - removed the required property `ancestorFolders/items/updatedAt` from the response with the `200` status
  - …2 more
- **2026-09-19** `761d42f61982`: 2 info
  - api tag `notebook-folder-controller` added
  - api tag `notebook-controller` removed
- **2026-07-22** `13f77438750e`: 6 warning, 6 info
  - removed the optional property `ancestorFolders/items/indexContent` from the response with the `200` status
  - removed the optional property `folder/indexContent` from the response with the `200` status
  - removed the optional property `indexContent` from the response with the `200` status
  - removed the optional property `indexNoteContent` from the response with the `200` status
  - …8 more
- **2026-05-12** `5c61e52feed2`: 2 warning
  - removed the optional property `folderIndexNoteId` from the response with the `200` status
  - removed the optional property `notebookRealm/indexNoteId` from the response with the `200` status
- …earlier changes not shown

[Operation history](https://skmtc.dev/nerds-odd-e/apis/odd-e-open-api/changes/api/notebooks/:notebook/folders/:folder/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)