---
title: "Returns all folder nodes in breadth-first order, each with path and optional parentPath."
method: GET
path: "/api/projects/{project-id}/quality/folders/inventory"
tags: ["quality"]
---

# Returns all folder nodes in breadth-first order, each with path and optional parentPath.

`GET /api/projects/{project-id}/quality/folders/inventory`

## Request

- Base URL: `https://codescene.io` (the document declares no server; this is the origin it was published from)
- URL: `https://codescene.io/api/projects/{project-id}/quality/folders/inventory`
- Auth: none declared

## Path parameters

- `project-id` integer, required

## Query parameters

- `pageSize` integer
- `pageToken` string

## Response `200`

- FolderInventory
  - `projectId` integer, required: Identifier of the project.
  - `asOf` string, date-time, required: ISO 8601 datetime of when the snapshot was taken.
  - `folders` object[], required: All folder nodes in breadth-first order, sorted alphabetically within each level.
    - `name` string, required: Name of the folder.
    - `path` string, required: Full path of the folder relative to the project root, using / as separator.
    - `parentPath` string: Path of the parent folder. Absent for top-level (repo root) folders.
  - `nextPageToken` string: Opaque cursor for the next page. Absent on the last page or when all results fit in one page.

## Other responses

- `400`
- `401`
- `403`
- `404`

---

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