Skip to main content
GET
/
v1
/
folders
/
{folder_id}
/
contents
List Folder Contents Handler
curl --request GET \
  --url http://localhost:8000/v1/folders/{folder_id}/contents
{
  "items": [
    {
      "part_type": "FOLDER",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "parent_path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "materialized_path": "<string>",
      "system_managed": true,
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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

Path Parameters

​
folder_id
string<uuid>
required

Query Parameters

​
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
​
with_tags
boolean
default:false

Include tag IDs for each item (default: false)

​
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
(FolderResponse · object | DocumentResponse · object)[]
required

List of items

Folder response model.

​
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