0

List Sheets

by
Published Oct 17, 2025

Gets a list of all sheets that the user has access to. The list contains an abbreviated Sheet object for each sheet.

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 Sheets
8
 * Gets a list of all sheets that the user has access to. The list contains an abbreviated Sheet object for each sheet.
9

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