Reference

Endpoint List Sheets

Name

get_sheets

Description

Get a list of Sheets. [API reference]

Related Tables

Sheets

Parameters

Parameter Required Options
Name: ModifiedSince

Label: 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: Include

Label: Include
Option Value
sheetVersion sheetVersion
source source
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
Name DT_WSTR nvarchar(255) 255
AccessLevel DT_WSTR nvarchar(50) 50
Permalink DT_WSTR nvarchar(2048) 2048
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 Sheets 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
Sheets
Optional Parameters
Modified Since
Include
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Sheets table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to list sheets:

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
Sheets
Select
Optional Parameters
Modified Since
Include
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Tables - Sheets 

SELECT * FROM Sheets --Where Id='5815807987847055'

get_sheets endpoint belongs to Sheets 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:

Tables - Sheets 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Sheets --Where Id=''5815807987847055''';

EXEC (@MyQuery) AT [LS_TO_SMARTSHEET_IN_GATEWAY];

get_sheets endpoint belongs to Sheets table(s), and can therefore be used via those table(s).