View as Markdown
Smartsheet icon

Smartsheet ACTION

Search

Full-text search across everything the account can see, or within a single sheet. This is the fastest way to find a sheet by name: results include whole objects, not just cell contents - each result carries an objectType of sheet, row, folder, workspace, report, template, attachment, discussion, sight or summaryField, and its objectId is that object's ID. So a result with objectType: "sheet" gives you the sheet ID directly in one call. Prefer this over List Sheets when you know part of a name; use List Sheets to enumerate everything or when you need each sheet's permalink. Searching by a sheet URL does not work - the URL token is not indexed text; pass the URL to Get Sheet instead, which resolves it for you. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Smartsheet account once, then configure and run Search from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "smartsheet-search",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    smartsheet: { authProvisionId: "apn_xxxxxxx" },
    query: "Search Query",
    sheetId: "Sheet ID or URL",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Search inputs
Property Type Description
query Search Query string
The text to search for across sheet contents.
Required
sheetId Sheet ID or URL string
Scope the search to a single sheet. If omitted, searches all sheets. Accepts a numeric sheet ID (e.g. 1234567890123456), or a Smartsheet sheet URL, which is resolved to the ID for you. Use List Sheets to enumerate sheets.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
smartsheet-search
Version
0.1.0
App
Smartsheet
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes