Skip to main content
GET
/
api
/
v1
/
folders
/
{id}
Get folder by ID
const url = 'https://studyfetchapi.com/api/v1/folders/{id}';
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": [
    {}
  ],
  "materialCount": 123
}

Authorizations

x-api-key
string
header
required

API Key for authentication

Path Parameters

id
string
required

Folder ID

Response

200 - application/json

Folder 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
object[]
required

Subfolders

materialCount
number
required

Total number of materials

parentFolderId
string | null

Parent folder ID

description
string

Folder description

metadata
object

Folder metadata

createdAt
object

Creation date

updatedAt
object

Last update date

I