0

List Folders in Home

by
Published Oct 17, 2025

> **IMPORTANT:** The `GET /home/folders` method is deprecated and will be removed. To adapt to this change, please see Migrate from using the Sheets folder. Lists the folders in your **Sheets** folder. The list contains an abbreviated Folder object for each folder.

Script smartsheet Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Smartsheet = {
3
  token: string;
4
  baseUrl: string;
5
};
6
/**
7
 * List Folders in Home
8
 * > **IMPORTANT:** The `GET /home/folders` method is deprecated and will be removed. To adapt to this change, please see Migrate from using the Sheets folder.
9

10
Lists the folders in your **Sheets** folder. The list contains an abbreviated Folder object for each folder.
11

12
 */
13
export async function main(
14
  auth: Smartsheet,
15
  includeAll: string | undefined,
16
  page: string | undefined,
17
  pageSize: string | undefined,
18
) {
19
  const url = new URL(`${auth.baseUrl}/home/folders`);
20
  for (const [k, v] of [
21
    ["includeAll", includeAll],
22
    ["page", page],
23
    ["pageSize", pageSize],
24
  ]) {
25
    if (v !== undefined && v !== "" && k !== undefined) {
26
      url.searchParams.append(k, v);
27
    }
28
  }
29
  const response = await fetch(url, {
30
    method: "GET",
31
    headers: {
32
      Authorization: "Bearer " + auth.token,
33
    },
34
    body: undefined,
35
  });
36
  if (!response.ok) {
37
    const text = await response.text();
38
    throw new Error(`${response.status} ${text}`);
39
  }
40
  return await response.json();
41
}
42