View as Markdown
Google Sheets icon

Google Sheets ACTION

List Worksheets

Get a list of all worksheets in a spreadsheet. 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 Worksheets 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-worksheets",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_sheets: { authProvisionId: "apn_xxxxxxx" },
    drive: "Drive",
    sheetId: "Spreadsheet ID",
  },
})

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 Worksheets inputs
Property Type Description
drive Drive string
The drive to select a spreadsheet from. If you are connected with any Google Shared Drives, you can select it here.
Optional Dynamic
sheetId Spreadsheet ID string
List worksheets in the specified spreadsheet
Required Dynamic

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-worksheets
Version
0.1.18
App
Google Sheets
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes