View as Markdown
Google Sheets icon

Google Sheets ACTION

Read Rows

Read rows from a Google Sheets worksheet. Returns data as objects (keys = column headers from row 1) by default, or as raw arrays. Use Get Spreadsheet Info first to discover worksheet names. Optionally specify a range in A1 notation (e.g., A2:D10) to read a subset. For searching rows by value, use Find Rows instead.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Google Sheets account once, then configure and run Read Rows 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-read-rows",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_sheets: { authProvisionId: "apn_xxxxxxx" },
    spreadsheetId: "Spreadsheet ID",
    sheetName: "Worksheet Name",
  },
})

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.

Read Rows inputs
Property Type Description
spreadsheetId Spreadsheet ID string
The spreadsheet ID from the Google Sheets URL.
Required
sheetName Worksheet Name string
The worksheet (tab) name. Use Get Spreadsheet Info to discover worksheet names.
Required
range Range string
Optional A1 notation range within the sheet (e.g., A1:D10, A:F). Omit to read all data.
Optional
hasHeaders Has Headers boolean
Whether row 1 contains column headers. If true, returns rows as objects with header keys. Default: true.
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-read-rows
Version
0.0.4
App
Google Sheets
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes