0

Get Summary Fields

by
Published Oct 17, 2025

Returns object containing array of summary fields. Allows for pagination of results.

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
 * Get Summary Fields
8
 * Returns object containing array of summary fields. Allows for pagination of results.
9
 */
10
export async function main(
11
  auth: Smartsheet,
12
  sheetId: string,
13
  includeAll: string | undefined,
14
  page: string | undefined,
15
  pageSize: string | undefined,
16
  include: "format" | "writerInfo" | undefined,
17
  exclude: "displayValue" | "image" | "imageAltText" | undefined,
18
) {
19
  const url = new URL(
20
    `${auth.baseUrl}/sheets/${sheetId}/summary/fields`,
21
  );
22
  for (const [k, v] of [
23
    ["includeAll", includeAll],
24
    ["page", page],
25
    ["pageSize", pageSize],
26
    ["include", include],
27
    ["exclude", exclude],
28
  ]) {
29
    if (v !== undefined && v !== "" && k !== undefined) {
30
      url.searchParams.append(k, v);
31
    }
32
  }
33
  const response = await fetch(url, {
34
    method: "GET",
35
    headers: {
36
      Authorization: "Bearer " + auth.token,
37
    },
38
    body: undefined,
39
  });
40
  if (!response.ok) {
41
    const text = await response.text();
42
    throw new Error(`${response.status} ${text}`);
43
  }
44
  return await response.json();
45
}
46