Smartsheet ACTION
Get Sheet
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
- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Smartsheet account once, then configure and run Get Sheet 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: "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 -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"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{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",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
sheetId Sheet ID or URL | string | 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. Required |
rowIds Row IDs | string | 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. Optional |
rowNumbers Row Numbers | string | Comma-separated row positions to return (e.g. 1,2,10). These are positions in the grid, not row IDs. Optional |
rowsModifiedSince Rows Modified Since | string | Return only rows modified at or after this time. ISO 8601, e.g. 2026-01-01T00:00:00Z. Optional |
columnIds Column IDs | string | Comma-separated column IDs to include (e.g. 7894561230,8794561230). Use List Columns to find column IDs. If omitted, all columns are returned. Optional |
include Include | string[] | 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. Optional |
exclude Exclude | string[] | Elements to omit from the response. linkInFromCellDetails and linksOutToCellsDetails trim a lot of payload on sheets with cross-sheet links. Optional |
filterId Filter ID | string | 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. Optional |
level Level | integer | 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. Optional |
page Page | integer | 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. Optional |
pageSize Page Size | integer | Rows per page. Defaults to 100. Raise it instead of paging when you want the whole sheet in one call. 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
- smartsheet-get-sheet
- Version
- 1.0.1
- App
- Smartsheet
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗