Export excel file via API

Buren
Buren
edited 01/03/25 in API & Developers

I want to use the API to export an Excel file. While reviewing the latest documentation, I couldn’t find any reference to this functionality. However, I discovered in historical posts that using the Accept: application/vnd.ms-excel header can achieve this. I tested it with the API, and it worked successfully.

Could you please confirm:

  1. Is this method officially supported, or has it been deprecated?
  2. Is it safe to rely on this approach for our processes?

Additionally, I noticed that historical posts referenced documentation related to this feature, but those links are no longer valid. If this method is officially supported, would it be possible to reinstate it in the current documentation for clarity?



FYI:

https://community.smartsheet.com/discussion/5140/download-sheet-data-via-api
https://stackoverflow.com/questions/21941525/smartsheet-download-sheet-as-excel-file-using-api

Best Answer

  • Georgie
    Georgie Employee
    Answer ✓

    Hi @Buren,

    The Get Sheet method is supported, and you can find an example of using this method to get a sheet as an Excel file under the Get Sheet section of the current API documentation, here.

    The links you’ve found to the section in the API documentation are old resources, which is why it links you to the top of the current, new documentation site, however the Excel example is still shown in the right hand panel for Get Sheet:

    Smartsheet Support does not handle SDK-related inquiries. If you’ve tested and found an issue with the SDK, please report it on the relevant GitHub page. You can access the links to these pages here: Smartsheet API Documentation.

    You may also find the following related Community threads helpful:

    Thanks,

    Georgie

    Join us for Jumpstart 2025 with Community on January 23 (in two time zones)! 🎉 Register here.

Answers

  • FYI:
    https://stackoverflow.com/questions/21941525/smartsheet-download-sheet-as-excel-file-using-api

  • Georgie
    Georgie Employee
    Answer ✓

    Hi @Buren,

    The Get Sheet method is supported, and you can find an example of using this method to get a sheet as an Excel file under the Get Sheet section of the current API documentation, here.

    The links you’ve found to the section in the API documentation are old resources, which is why it links you to the top of the current, new documentation site, however the Excel example is still shown in the right hand panel for Get Sheet:

    Smartsheet Support does not handle SDK-related inquiries. If you’ve tested and found an issue with the SDK, please report it on the relevant GitHub page. You can access the links to these pages here: Smartsheet API Documentation.

    You may also find the following related Community threads helpful:

    Thanks,

    Georgie

    Join us for Jumpstart 2025 with Community on January 23 (in two time zones)! 🎉 Register here.