# Get Spreadsheet — Microsoft Excel

> Get the values of a specified Excel worksheet. See the documentation

- Key: `microsoft_excel-get-spreadsheet`
- Type: Action (Read-only)
- Version: 0.0.4
- App: Microsoft Excel (`microsoft_excel`) — https://pipedream.com/apps/microsoft-excel.md
- This page (HTML): https://pipedream.com/apps/microsoft-excel/actions/get-spreadsheet
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/microsoft_excel/actions/get-spreadsheet/get-spreadsheet.mjs

## Description

Get the values of a specified Excel worksheet. [See the documentation](https://learn.microsoft.com/en-us/graph/api/range-get?view=graph-rest-1.0&tabs=http)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `folderId` | `string` | Yes | The ID of the folder where the item is located Options are loaded from the connected account. |
| `sheetId` | `string` | Yes | The ID of the spreadsheet you want to use Options are loaded from the connected account. |
| `worksheet` | `string` | Yes | The name of the worksheet to use Options are loaded from the connected account. |
| `range` | `string` | No | The range within the worksheet to retrieve. E.g. A1:C4. If not specified, entire "usedRange" will be returned |

## 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": "microsoft_excel",
      },
    },
  },
)

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: "microsoft_excel-get-spreadsheet",
  arguments: {
    folderId: "Folder ID",
    sheetId: "Sheet ID",
  },
})
```

**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: "microsoft_excel-get-spreadsheet",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    microsoft_excel: { authProvisionId: "apn_xxxxxxx" },
    folderId: "Folder ID",
    sheetId: "Sheet ID",
  },
})

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": "microsoft_excel-get-spreadsheet",
    "configured_props": {
      "microsoft_excel": { "authProvisionId": "apn_xxxxxxx" },
      "folderId": "Folder ID",
      "sheetId": "Sheet ID"
    }
  }'
```

---

- App: https://pipedream.com/apps/microsoft-excel.md · All apps: https://pipedream.com/apps