# Get Sheet — Smartsheet

> Get a sheet's full structure: column definitions (name, type, options, ID), all rows with cell values, and sheet metadata. This is the primary schema discovery tool - call it BEFORE Add Row to Sheet or Update Row to learn column names…

- Key: `smartsheet-get-sheet`
- Type: Action (Read-only)
- Version: 1.0.1
- App: Smartsheet (`smartsheet`) — https://pipedream.com/apps/smartsheet.md
- This page (HTML): https://pipedream.com/apps/smartsheet/actions/get-sheet
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/smartsheet/actions/get-sheet/get-sheet.mjs

## Description

Get a sheet's full structure: column definitions (name, type, options, ID), all rows with cell values, and sheet metadata. This is the primary schema discovery tool - call it BEFORE **Add Row to Sheet** or **Update Row** to learn column names, types, and IDs. Returns rows with cell values keyed by column name for readability. For a lightweight column-only view, use **List Columns** instead. [See the documentation](https://developers.smartsheet.com/api/smartsheet/openapi/sheets/getsheet)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `sheetId` | `string` | Yes | The sheet to act on. Accepts a numeric sheet ID (e.g. 1234567890123456), or a Smartsheet sheet URL, which is resolved to the ID for you. Use List Sheets to enumerate sheets, or Search to find one by name. |
| `rowIds` | `string` | No | Comma-separated row IDs to return (e.g. 1234567890,9876543210). Far cheaper than fetching the whole sheet when you already know the rows. Use Search to find row IDs. |
| `rowNumbers` | `string` | No | Comma-separated row positions to return (e.g. 1,2,10). These are positions in the grid, not row IDs. |
| `rowsModifiedSince` | `string` | No | Return only rows modified at or after this time. ISO 8601, e.g. 2026-01-01T00:00:00Z. |
| `columnIds` | `string` | No | Comma-separated column IDs to include (e.g. 7894561230,8794561230). Use List Columns to find column IDs. If omitted, all columns are returned. |
| `include` | `string[]` | No | Extra elements to fold into the response. Set filters to discover saved filter IDs, which is the only way to get them since Smartsheet exposes no filters endpoint. |
| `exclude` | `string[]` | No | Elements to omit from the response. linkInFromCellDetails and linksOutToCellsDetails trim a lot of payload on sheets with cross-sheet links. |
| `filterId` | `string` | No | Apply a saved filter to the returned rows (e.g. 1234567890123456). An ID this sheet does not have is ignored silently rather than erroring, so confirm it first: run Get Sheet with filters in Include and read the returned filters array. Smartsheet exposes no filters endpoint, so that is the only way to discover one. |
| `level` | `integer` | No | Response format for multi-value columns. At the default level 0 a MULTI_PICKLIST or MULTI_CONTACT_LIST column is reported as TEXT_NUMBER for backwards compatibility, so pass 2 when you need the real column type. Pair it with objectValue in Include to get structured cell values. |
| `page` | `integer` | No | 1-based page of rows to return. Sheets paginate at 100 rows by default, so a large sheet needs either this or a bigger Page Size. |
| `pageSize` | `integer` | No | Rows per page. Defaults to 100. Raise it instead of paging when you want the whole sheet in one call. |

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

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: "smartsheet-get-sheet",
  arguments: {
    sheetId: "Sheet ID or URL",
    rowIds: "Row IDs",
  },
})
```

**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: "smartsheet-get-sheet",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    smartsheet: { authProvisionId: "apn_xxxxxxx" },
    sheetId: "Sheet ID or URL",
    rowIds: "Row IDs",
  },
})

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": "smartsheet-get-sheet",
    "configured_props": {
      "smartsheet": { "authProvisionId": "apn_xxxxxxx" },
      "sheetId": "Sheet ID or URL",
      "rowIds": "Row IDs"
    }
  }'
```

---

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