---
title: "Get folder path hierarchy"
method: GET
path: "/matters/{matterId}/documents/folders/{folderId}/path"
tags: ["Folders"]
---

# Get folder path hierarchy

`GET /matters/{matterId}/documents/folders/{folderId}/path`

## Request

- Base URL: `https://api.smokeball.com`
- URL: `https://api.smokeball.com/matters/{matterId}/documents/folders/{folderId}/path`
- Auth: API key in header `x-api-key` and API key in header `Authorization`

Returns the full folder hierarchy (path) as a collection ordered from the root folder down to the supplied folder.

The root folder is not included in the response.

## Path parameters

- `matterId` string, required
- `folderId` string, required

## Response `200`

When request is successful. Returns the folder path hierarchy.

- FolderPathSegmentCollection
  - `id` string, nullable
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `value` FolderPathSegment[], nullable
    - `id` string, nullable: Unique identifier of the folder
    - `name` string, nullable: Name of the folder
    - `parentId` string, nullable: Unique identifier of the parent folder. Null when the folder sits directly under the matter root.
    - `depth` integer: The depth of the folder in the folder path hierarchy. 0 indicates the root folder, 1 indicates a direct child of that folder, and so on.

## Other responses

- `400`: When a supplied id is not a valid GUID.
- `403`: When the requested matter does not belong to the account making the request, or the folder does not belong to the specified matter.
- `404`: When folder with the specified id does not exist.

## Changes

- **2026-08-26** `db1b8a86b58e`: 1 info
  - added the non-success response with the status `400`

[Operation history](https://skmtc.dev/smokeball/apis/smokeball-api/changes/matters/:matterId/documents/folders/:folderId/path/get.md)

---

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