View as Markdown
Google Sheets icon

Google Sheets ACTION

List Spreadsheets

List Google Spreadsheets accessible to the authenticated user. Optionally search by name with query. Returns an array of { spreadsheetId, name, url } whose IDs can be used with all other tools. Returns up to limit results (default 20); when more may exist the summary says so — raise limit to fetch them. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Google Sheets account once, then configure and run List Spreadsheets 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: "google_sheets-list-spreadsheets",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_sheets: { authProvisionId: "apn_xxxxxxx" },
    query: "Search Query",
    limit: 10,
  },
})

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.

List Spreadsheets inputs
Property Type Description
query Search Query string
Search spreadsheets by name. Leave empty to list all.
Optional
limit Limit integer
Maximum number of spreadsheets to return. Default: 20.
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
google_sheets-list-spreadsheets
Version
0.1.1
App
Google Sheets
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes