Skip to main content
GET
/
api
/
v1
/
folders
/
tree
Get folder tree structure
const url = 'https://studyfetchapi.com/api/v1/folders/tree';
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}, body: undefined};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
[
  {
    "_id": {},
    "name": "<string>",
    "organizationId": "<string>",
    "parentFolderId": "<string>",
    "description": "<string>",
    "status": "active",
    "metadata": {
      "color": "<string>",
      "icon": "<string>",
      "materialCount": 123,
      "totalSize": 123,
      "lastActivity": "2023-11-07T05:31:56Z"
    },
    "createdAt": {},
    "updatedAt": {},
    "subfolders": [
      "<any>"
    ]
  }
]

Authorizations

x-api-key
string
header
required

API Key for authentication

Response

200 - application/json

Folder tree retrieved successfully

_id
object
required

Folder ID

name
string
required

Folder name

organizationId
string
required

Organization ID

status
enum<string>
required

Folder status

Available options:
active,
deleted
subfolders
any[]
required

Nested subfolders

parentFolderId
string | null

Parent folder ID

description
string

Folder description

metadata
object

Folder metadata

createdAt
object

Creation date

updatedAt
object

Last update date

I