# List Spreadsheets — Google Sheets

> 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)…

- Key: `google_sheets-list-spreadsheets`
- Type: Action (Read-only)
- Version: 0.1.1
- App: Google Sheets (`google_sheets`) — https://pipedream.com/apps/google-sheets.md
- This page (HTML): https://pipedream.com/apps/google-sheets/actions/list-spreadsheets
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/google_sheets/actions/list-spreadsheets/list-spreadsheets.mjs

## Description

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](https://developers.google.com/drive/api/v3/reference/files/list)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `query` | `string` | No | Search spreadsheets by name. Leave empty to list all. |
| `limit` | `integer` | No | Maximum number of spreadsheets to return. Default: 20. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "google_sheets",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "google_sheets-list-spreadsheets",
  arguments: {
    query: "Search Query",
    limit: 10,
  },
})
```

**TypeScript**

```ts
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)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "google_sheets-list-spreadsheets",
    "configured_props": {
      "google_sheets": { "authProvisionId": "apn_xxxxxxx" },
      "query": "Search Query",
      "limit": 10
    }
  }'
```

---

- App: https://pipedream.com/apps/google-sheets.md · All apps: https://pipedream.com/apps