API & Developers

API & Developers

Connect with other developers from around the world and collaborate on ideas using the Smartsheet API.

How to Access Smartsheet Dashboards via API?

Hi Smartsheet Community,

I’m currently working on integrating Smartsheet into my system and need to know if there’s a REST API available to fetch Dashboards data. I’ve checked the API documentation but couldn’t find a direct reference.

  • Is there any official or workaround method for accessing dashboard elements via API?
  • If not, are there any plans to introduce this feature?
  • Any third-party tools that can help with this?

Answers

  • Community Champion

    Hi @yashtw103

    As far as I know, no REST API method is currently available to access or update Dashboard widgets in Smartsheet directly. While the API does support a wide range of capabilities for sheets, reports, and other objects, dashboards are not yet exposed via the API.

    I’m also unaware of any official workarounds or third-party tools that provide access to dashboard elements. That said, Smartsheet is constantly evolving, and this would be a helpful feature.

    Note: Another notable limitation of the current Smartsheet API is the lack of support for managing or retrieving Forms. Like Dashboards, forms are also not accessible via the API at this time.

  • ✭✭

    Hi @yashtw103,

    Smartsheet API does support Dashboard which called "Sight".

    • For getting Dashboard data, you can use endpoint: GET /sights/{sightId}
    • For updating Dashboard data, I not sure if you can update the widget content directly but you can update some simple info using endpoint: PUT /sights/{sightId}

    I Hope this helps.

  • Community Champion

    Thanks @truyenh for the input!

    Just to clarify further—while the Smartsheet API does support interaction with dashboards (called "sights" in the API), that support is mostly read-only when it comes to internal components.

    You can use the API to retrieve a dashboard and get detailed information about each widget (including type, content, layout, and styling). For example, GET /sights/{sightId} returns full widget metadata such as rich text content, hyperlinks, and image references.

    However, these widget fields are not writable—you cannot use the API to create, update, move, or delete individual widgets or change their styling/layout.

    According to the official API documentation, here’s what is supported:

    • Rename the dashboard
    • Copy, move, or delete the dashboard
    • Adjust publish settings
    • Manage sharing permissions (add/update/remove users/groups)

    So, while you can read widget data, there is currently no way to programmatically modify widget contents or layout via the API.

  • ✭✭✭✭✭

    yashtw103

    Dashboards are not representations of data as far as the API is concerned, it is a collection of widgets. To accomplish what you are looking to do you would simply call the sheet or report apis to get the original data. The areas where this isn't great are like text and images. You could still model those things into your blueprint structure but all data wise you just get it from the source then process it in your ETL.

    Principal Consultant | System Integrations

    Prime Consulting Group

    Email: info@primeconsulting.com

    Follow us on LinkedIn!

NEW Smartsheet API Documentation - bookmark the updated link! https://developers.smartsheet.com

Trending in API & Developers