Smartsheet logo

Methods

Import Sheet into Folder

Imports CSV or XLSX data into a new sheet in the specified folder.

Note the following:

  • Both sheetName and the file name must use ASCII characters.
  • The source data must be basic text. To include rich formula data, import and create a sheet first, and then use Update Rows. To work with images, see Cell Images.
  • XLS is not supported. You must use XLSX.
  • Hierarchical relationships between rows in an external file won't import.
Authorizations:
APITokenOAuth2 (CREATE_SHEETS)
path Parameters
folderId
required
number

Folder Id where you can create sheets, sights, reports, templates, and other folders.

query Parameters
sheetName
required
string

Desired name of the sheet.

headerRowIndex
number

A zero-based integer indicating the row number to use for column names. Rows before this are omitted. If not specified, the default values are Column1, Column2, etc.

primaryColumnIndex
number
Default: 0

A zero-based integer indicating the column to designate as primary.

header Parameters
Authorization
string

API Access Token used to authenticate requests to Smartsheet APIs.

Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789
Content-Disposition
string

Should be equal to "attachment" to tell the API that a file is in the body of the POST request, followed by a semicolon, followed by filename= and the URL-encoded filename in quotes

Example: attachment; filename="ProgressReport.docx"
Content-Type
required
string

Required for POST request to import a sheet from CSV/XLSX file.

  • For CSV files, use: Content-Type: text/csv
  • For XLSX files, use: Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Enum: "text/csv" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
Request Body schema: application/octet-stream

Binary content for the CSV / XLSX file.

string <binary>

Responses

Request samples 

curl  https://api.smartsheet.com/2.0/folders/{folderId}/sheets/import?sheetName=MarketingProgressReport&headerRowIndex=0&primaryColumnIndex=0 \
-H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789" \
-H "Content-Disposition: attachment" \
-H "Content-Type: text/csv" \
-X POST \
--data-binary @ProgressReport.csv

Response samples

Content type
application/json
{
  • "message": "SUCCESS",
  • "resultCode": 0,
  • "result": {
    }
}

Import Sheet from CSV / XLSX

Imports CSV or XLSX data into a new sheet in the top-level "Sheets" folder.

Note the following:

  • Both sheetName and the file name must use ASCII characters.
  • The source data must be basic text. To include rich formula data, import and create a sheet first, and then use Update Rows. To work with images, see Cell Images.
  • XLS is not supported. You must use XLSX.
  • Hierarchical relationships between rows in an external file won't import.
Authorizations:
APITokenOAuth2 (CREATE_SHEETS)
query Parameters
sheetName
required
string

Desired name of the sheet.

headerRowIndex
number

A zero-based integer indicating the row number to use for column names. Rows before this are omitted. If not specified, the default values are Column1, Column2, etc.

primaryColumnIndex
number
Default: 0

A zero-based integer indicating the column to designate as primary.

header Parameters
Authorization
string

API Access Token used to authenticate requests to Smartsheet APIs.

Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789
Content-Disposition
string

Should be equal to "attachment" to tell the API that a file is in the body of the POST request, followed by a semicolon, followed by filename= and the URL-encoded filename in quotes

Example: attachment; filename="ProgressReport.docx"
Content-Type
required
string

Required for POST request to import a sheet from CSV/XLSX file.

  • For CSV files, use: Content-Type: text/csv
  • For XLSX files, use: Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Enum: "text/csv" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
Request Body schema: application/octet-stream

Binary content for the CSV / XLSX file.

string <binary>

Responses

Request samples 

curl  https://api.smartsheet.com/2.0/sheets/import?sheetName=MarketingProgressReport&headerRowIndex=0&primaryColumnIndex=0 \
-H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789" \
-H "Content-Disposition: attachment" \
-H "Content-Type: text/csv" \
-X POST \
--data-binary @ProgressReport.csv

Response samples

Content type
application/json
{
  • "message": "SUCCESS",
  • "resultCode": 0,
  • "result": {
    }
}

Import Sheet into Workspace

Imports CSV or XLSX data into a new sheet in the specified workspace.

Note the following:

  • Both sheetName and the file name must use ASCII characters.
  • The source data must be basic text. To include rich formula data, import and create a sheet first, and then use Update Rows. To work with images, see Cell Images.
  • XLS is not supported. You must use XLSX.
  • Hierarchical relationships between rows in an external file won't import.
Authorizations:
APITokenOAuth2 (CREATE_SHEETS)
path Parameters
workspaceId
required
string

WorkspaceID of the worksheet being accessed.

query Parameters
sheetName
required
string

Desired name of the sheet.

headerRowIndex
number

A zero-based integer indicating the row number to use for column names. Rows before this are omitted. If not specified, the default values are Column1, Column2, etc.

primaryColumnIndex
number
Default: 0

A zero-based integer indicating the column to designate as primary.

header Parameters
Authorization
string

API Access Token used to authenticate requests to Smartsheet APIs.

Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789
Content-Disposition
string

Should be equal to "attachment" to tell the API that a file is in the body of the POST request, followed by a semicolon, followed by filename= and the URL-encoded filename in quotes

Example: attachment; filename="ProgressReport.docx"
Content-Type
required
string

Required for POST request to import a sheet from CSV/XLSX file.

  • For CSV files, use: Content-Type: text/csv
  • For XLSX files, use: Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Enum: "text/csv" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
Request Body schema: application/octet-stream

Binary content for the CSV / XLSX file.

string <binary>

Responses

Request samples 

curl  https://api.smartsheet.com/2.0/workspaces/{workspaceId}/sheets/import?sheetName=MarketingProgressReport&headerRowIndex=0&primaryColumnIndex=0 \
-H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789" \
-H "Content-Disposition: attachment" \
-H "Content-Type: text/csv" \
-X POST \
--data-binary @ProgressReport.csv

Response samples

Content type
application/json
{
  • "message": "SUCCESS",
  • "resultCode": 0,
  • "result": {
    }
}
➔ Next to Proofs Basics