path-parts

List Path Parts Handler

List path parts (folders) under a parent with traversal.

This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts.

If parent_path_id is not provided, lists contents of the root folder.
max_depth controls how deep to traverse (1 = direct children only).
sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT.

For listing folder contents that includes documents with enriched metadata, use GET /folders//contents instead.

GET

path-parts

List Path Parts Handler

curl --request GET \
  --url http://localhost:8000/v1/path-parts

{
  "items": [
    {
      "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "parent_path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata_obj_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "materialized_path": "<string>",
      "system_managed": true,
      "can_read": true,
      "can_write": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "color": "<string>",
          "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "description": "<string>"
        }
      ]
    }
  ],
  "total": 1,
  "limit": 2,
  "offset": 1
}

Headers

authorization

string | null

Query Parameters

parent_path_id

string<uuid> | null

Parent PathPart ID (defaults to root)

max_depth

integer

default:1

Maximum depth to traverse (1 = direct children, default: 1)

Required range: x >= 1

sort_order

enum<string>

default:LOGICAL

Sort order for results (default: LOGICAL)

Available options:

LOGICAL,

NAME,

UPDATED_AT,

CREATED_AT

limit

integer

default:20

Number of items per page

Required range: 1 <= x <= 100

offset

integer

default:0

Number of items to skip

Required range: x >= 0

Cookies

ks_uat

string | null

Response

Successful Response

items

PathPartResponse · object[]

required

List of items

Show child attributes

total

integer

required

Total number of items

Required range: x >= 0

limit

integer

required

Number of items per page

Required range: x >= 1

offset

integer

required

Number of items to skip

Required range: x >= 0

Get Path Part HandlerGet a path part by its ID. Returns the path part with its attached tag IDs.

List Path Parts Handler

curl --request GET \
  --url http://localhost:8000/v1/path-parts

{
  "items": [
    {
      "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "parent_path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata_obj_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "materialized_path": "<string>",
      "system_managed": true,
      "can_read": true,
      "can_write": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "color": "<string>",
          "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "description": "<string>"
        }
      ]
    }
  ],
  "total": 1,
  "limit": 2,
  "offset": 1
}