0

Search Sheet

by
Published Oct 17, 2025

Gets a list of the user's search results in a sheet based on query. The list contains an abbreviated row object for each search result in a sheet. If you have not used the public API in a while, we will need to provision your data. This could take up to 24 hours so please check back later! *Note* Newly created or recently updated data may not be immediately discoverable via search.

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
 * Search Sheet
8
 * Gets a list of the user's search results in a sheet based on query. The list contains an abbreviated row object for each search result in a sheet. If you have not used the public API in a while, we will need to provision your data. This could take up to 24 hours so please check back later! *Note* Newly created or recently updated data may not be immediately discoverable via search.
9
 */
10
export async function main(
11
  auth: Smartsheet,
12
  sheetId: string,
13
  query: string | undefined,
14
) {
15
  const url = new URL(`${auth.baseUrl}/search/sheets/${sheetId}`);
16
  for (const [k, v] of [["query", query]]) {
17
    if (v !== undefined && v !== "" && k !== undefined) {
18
      url.searchParams.append(k, v);
19
    }
20
  }
21
  const response = await fetch(url, {
22
    method: "GET",
23
    headers: {
24
      Authorization: "Bearer " + auth.token,
25
    },
26
    body: undefined,
27
  });
28
  if (!response.ok) {
29
    const text = await response.text();
30
    throw new Error(`${response.status} ${text}`);
31
  }
32
  return await response.json();
33
}
34