Reference

Endpoint Get Sheet Rows

Name

get_sheet_rows

Description

Get Sheet rows by Sheet ID. [API reference]

Related Tables

[Dynamic Table]

Parameters

Parameter Required Options
Name: SheetId

Label: SheetId

 YES
Name: RowsModifiedSince

Label: Rows Modified Since
Option Value
2020-01-30T13:25:32 2020-01-30T13:25:32
2020-01-30 2020-01-30
now now
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
today-24h today-24h
now-24h now-24h
now-1d now-1d
today+7d today+7d
Name: Exclude

Label: Exclude

A comma-separated list of optional elements to not include in the response: filteredOutRows - excludes filtered out rows from response payload if a sheet filter is applied; includes total number of filtered rows linkInFromCellDetails - excludes the following attributes from the cell.linkInFromCell object: columnId, rowId, status linksOutToCellsDetails - excludes the following attributes from the cell.linksOutToCells array elements: columnId, rowId, status nonexistentCells - excludes cells that have never contained any data
Option Value
filteredOutRows filteredOutRows
linkInFromCellDetails linkInFromCellDetails
linksOutToCellsDetails linksOutToCellsDetails
nonexistentCells nonexistentCells
Name: Include

Label: Include

A comma-separated list of optional elements to include in the response: attachments - includes the metadata for sheet-level and row-level attachments. To include discussion attachments, both attachments and discussions must be present in the include list. columnType -includes columnType attribute in the row's cells indicating the type of the column the cell resides in. crossSheetReferences - includes the cross-sheet references discussions - includes sheet-level and row-level discussions. To include discussion attachments, both attachments and discussions must be present in the include list. filters - includes filteredOut attribute indicating if the row should be displayed or hidden according to the sheet's filters. filterDefinitions - includes type of filter, operators used, and criteria format - includes column, row, cell, and summary fields formatting. ganttConfig - includes Gantt chart details. objectValue - when used in combination with a level query parameter, includes the email addresses for multi-contact data. ownerInfo - includes the owner's email address and the owner's user Id. rowPermalink - includes permalink attribute that represents a direct link to the row in the Smartsheet application. source - adds the Source object indicating which report, sheet Sight (aka dashboard), or template the sheet was created from, if any. writerInfo - includes createdBy and modifiedBy attributes on the row or summary fields, indicating the row or summary field's creator, and last modifier.
Option Value
attachments attachments
columnType columnType
crossSheetReferences crossSheetReferences
discussions discussions
filters filters
filterDefinitions filterDefinitions
format format
ganttConfig ganttConfig
objectValue objectValue
ownerInfo ownerInfo
rowPermalink rowPermalink
source source
writerInfo writerInfo
Name: ColumnIds

Label: Column Ids (Default=All Columns)

A comma-separated list of column ids. The response contains only the specified columns in the columns array, and individual rows' cells array only contains cells in the specified columns.
Name: PageSize

Label: PageSize

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_I8 bigint
CreatedAt DT_DBTIMESTAMP datetime
ModifiedAt DT_DBTIMESTAMP datetime
CreatedAtLocalTime DT_DBTIMESTAMP datetime
ModifiedAtLocalTime DT_DBTIMESTAMP datetime
RowNumber DT_I4 int Row number
[$parent.title$] DT_WSTR nvarchar(2000) 2000
PrevRowId DT_I8 bigint
If the column you are looking for is missing, consider customizing Smartsheet Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Smartsheet Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the [Dynamic Table] table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Smartsheet
Read / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Insert, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding with easy to use high performance API Connector
Smartsheet
[Dynamic Table]
There are no parameters to configure.
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the [Dynamic Table] table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get sheet rows:

API Destination - Smartsheet
Read / write SmartSheet data inside your app, perform many SmartSheet operations such as Read, Insert, Update, Delete, List, Search, Export on objects like Sheets, Rows, Users etc without coding with easy to use high performance API Connector
Smartsheet
[Dynamic Table]
Select
There are no parameters to configure.
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get sheet rows 

SELECT * FROM [dynamic_table_name]

get_sheet_rows endpoint belongs to [Dynamic Table] table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get sheet rows 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM [dynamic_table_name]';

EXEC (@MyQuery) AT [LS_TO_SMARTSHEET_IN_GATEWAY];

get_sheet_rows endpoint belongs to [Dynamic Table] table(s), and can therefore be used via those table(s).