Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Smartsheet

Scalekit connector
Open markdown

The Smartsheet connector lets your AI agent act in each user's Smartsheet account. Each user signs in to Smartsheet once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 27 tools.

Tools
27
What they doRead · write · destructive
18 · 8 · 118 read8 write1 destructive
Users sign in with
OAuth app
Your own Smartsheet app

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Smartsheet connection

    In AgentKit > Connections, create a Smartsheet connection and copy its redirect URI. The name you give it is the connection_name your code passes. See Configure connections.

  4. Register an OAuth app

    Smartsheet connections use your own OAuth app. Register one with Smartsheet and add the redirect URI you copied.

    Then enter the app's Client ID and Client Secret on the Smartsheet connection.

  5. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'smartsheet'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Smartsheet:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'smartsheet_current_user_get',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user signs in once. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • smartsheet_attachments_listList all attachments on a sheet, including those on its rows and in its discussions.Read-only

    List Attachments

    List all attachments on a sheet, including those on its rows and in its discussions. Returns each attachment's id, name, attachmentType (FILE, LINK, GOOGLE_DRIVE, and others), mimeType, sizeInKb, parentType, parentId, and createdAt. File contents are not returned. Use smartsheet_attachments_list to see what files and links a sheet holds.

    Inputs

    sheet_idstringrequired
    ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
    include_allboolean
    Set to true to return every item in one response instead of paging. Defaults to false. Example: true.
    pageinteger
    Page number to return, starting at 1. Defaults to 1. A page past the end returns the last page. Ignored when include_all is true. Example: 2.
    page_sizeinteger
    Maximum number of items per page. Defaults to 100. Ignored when include_all is true. Example: 50.
  • smartsheet_columns_listList the columns of a sheet.Read-only

    List Columns

    List the columns of a sheet. Returns each column's id, index, title, type, primary flag, and options (for picklist columns). Use smartsheet_columns_list to get the column ids that smartsheet_rows_add and smartsheet_rows_update need. Use smartsheet_sheet_get to read columns together with row data.

    Inputs

    sheet_idstringrequired
    ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
    include_allboolean
    Set to true to return every item in one response instead of paging. Defaults to false. Example: true.
    levelinteger
    Format for multi-contact and multi-picklist cells. 0 (default) returns them as plain text; 1 returns multi-contact cells as objects; 2 also returns multi-picklist cells as objects. Combine with include=objectValue to get contact email addresses. Example: 2.one of 012
    pageinteger
    Page number to return, starting at 1. Defaults to 1. A page past the end returns the last page. Ignored when include_all is true. Example: 2.
    page_sizeinteger
    Maximum number of items per page. Defaults to 100. Ignored when include_all is true. Example: 50.
  • smartsheet_current_user_getGet the profile of the Smartsheet user who authorized this connection.Read-only

    Get Current User

    Get the profile of the Smartsheet user who authorized this connection. Returns the user's id, email, first and last name, locale, time zone, account details, and admin flags, plus their groups when requested. Use it to learn who the connection acts as, for example before sharing an asset or filtering by owner.

    Inputs

    includestring
    Set to groups to also return the groups (id, name, description) the user belongs to. Leave empty for the profile only. Example: "groups".one of groups
  • smartsheet_discussion_getGet one discussion on a sheet with all its comments.Read-only

    Get Discussion

    Get one discussion on a sheet with all its comments. Returns the discussion's id, title, parentId, parentType, and comments (id, text, createdBy, createdAt). Use smartsheet_discussion_get to read a full thread. Use smartsheet_comment_create to reply to it.

    Inputs

    discussion_idstringrequired
    ID of the discussion, as returned in the id field by smartsheet_discussions_list. Example: "3962273862576004".
    sheet_idstringrequired
    ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
  • smartsheet_discussions_listList the discussions (comment threads) on a sheet, including those on its rows.Read-only

    List Discussions

    List the discussions (comment threads) on a sheet, including those on its rows. Returns each discussion's id, title, parentId, parentType (SHEET or ROW), commentCount, and lastCommentedAt, plus the comments when requested. Use smartsheet_discussions_list to browse conversations on a sheet. Use smartsheet_discussion_get to read one thread in full.

    Inputs

    sheet_idstringrequired
    ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
    includestring
    Comma-separated extra data: comments (every comment in each thread) and attachments (comment attachments; only works together with comments). Example: "comments".
    include_allboolean
    Set to true to return every item in one response instead of paging. Defaults to false. Example: true.
    pageinteger
    Page number to return, starting at 1. Defaults to 1. A page past the end returns the last page. Ignored when include_all is true. Example: 2.
    page_sizeinteger
    Maximum number of items per page. Defaults to 100. Ignored when include_all is true. Example: 50.
  • smartsheet_folder_children_listList the sheets, reports, dashboards, sub-folders, and templates directly inside a folder.Read-only

    List Folder Contents

    List the sheets, reports, dashboards, sub-folders, and templates directly inside a folder. Returns each child's id, name, resourceType, and permalink, plus lastKey when more pages exist. Items inside sub-folders are not included. Use smartsheet_folder_children_list to browse a folder. Use smartsheet_workspace_children_list for the top level of a workspace.

    Inputs

    folder_idstringrequired
    ID of the folder, as a numeric string. Get it from smartsheet_workspace_children_list or smartsheet_folder_children_list. Example: "5709073300645764".
    children_resource_typesstring
    Comma-separated child types to return. Allowed: sheets, reports, sights (dashboards), folders, templates. If you include templates, also include sheets. Leave empty for all types. Example: "sheets,folders".
    includestring
    Comma-separated extra data for each child: source (what it was created from) and ownerInfo (the owner's user). Example: "ownerInfo".
    last_keystring
    Paging token. Pass the lastKey value from the previous response to get the next page; leave empty for the first page. Example: "MTIzNDU2Nzg5".
    max_itemsinteger
    Maximum number of items to return. The minimum and default is 100, the maximum is 1000. Example: 200.
  • smartsheet_folder_getGet the details of one folder, without its contents.Read-only

    Get Folder

    Get the details of one folder, without its contents. Returns the folder's id, name, permalink, createdAt, and modifiedAt. Use smartsheet_folder_get for folder details. Use smartsheet_folder_children_list for the sheets, reports, and sub-folders inside it.

    Inputs

    folder_idstringrequired
    ID of the folder, as a numeric string. Get it from smartsheet_workspace_children_list or smartsheet_folder_children_list. Example: "5709073300645764".
    includestring
    Set to source to add the object the folder was created from, if any. Example: "source".one of source