---
title: "List notes, folders, and files at notebook root or under a parent folder"
method: GET
path: "/api/notebooks/{notebook}/folder-listing"
tags: ["notebook-folder-controller"]
---

# List notes, folders, and files at notebook root or under a parent folder

`GET /api/notebooks/{notebook}/folder-listing`

## Request

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

Without parent: notes and files with no folder assignment and top-level folders (notebook root scope). With parent: notes and files in that folder and its immediate child folders. The parent folder must belong to the notebook.

## Path parameters

- `notebook` integer, required

## Query parameters

- `parent` integer

## Response `200`

OK

- FolderListing: Note topologies, child folders, and files in a structural listing scope (e.g. notebook root or a folder).
  - `noteTopologies` NoteTopology[]
    - `id` integer, required
    - `title` string, required
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
  - `folders` Folder[]
    - `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
  - `attachments` NotebookAttachmentListItem[]
    - `id` integer, required
    - `filename` string, required

## Changes

- **2026-09-24** `c6f484f039b7`: 1 info
  - added the optional property `attachments` to the response with the `200` status
- **2026-09-19** `761d42f61982`: 2 info
  - api tag `notebook-folder-controller` added
  - api tag `notebook-controller` removed
- **2026-07-22** `13f77438750e`: 1 warning, 1 info
  - removed the optional property `folders/items/indexContent` from the response with the `200` status
  - added the optional property `folders/items/readmeContent` to the response with the `200` status
- **2026-05-12** `de5624b4a98c`: 1 info
  - added the optional property `folders/items/indexContent` to the response with the `200` status
- **2026-05-11** `d7c2946139e9`: 1 warning
  - removed the optional property `folders/items/indexContent` from the response with the `200` status

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