Smartsheet Connector

ZappySys Smartsheet Connector provide read / write capability inside your app (see list below), using these drag and drop , high performance connector you can perform many Smartsheet operations without any coding. You can use this connector to integrate Smartsheet data inside apps like SSIS, SQL Server or popular ETL Platforms / BI Tools/ Reporting Apps / Programming languages (i.e. Informatica, Power BI, SSRS, Excel, C#, JAVA, Python)

Download for SSIS Download for Other Apps Documentation

Click on your App below to get started with Smartsheet Integration

Choose your App / Scenario for which you like to integrate Smartsheet

Actions supported by Smartsheet Connector

Smartsheet Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 Search (cell data or other object types)
Get a list of search result object.    [Read more...]
Parameter Description
Search Query (use double quotes for exact search)
SheetId
Scope
Option Value
cellData cellData
attachments attachments
comments comments
folderNames folderNames
reportNames reportNames
sheetNames sheetNames
sightNames sightNames
summaryFields summaryFields
templateNames templateNames
workspaceNames workspaceNames
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
 List Sheets
Get a list of Sheets.    [Read more...]
Parameter Description
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
Include
Option Value
sheetVersion sheetVersion
source source
 Get Sheet Fields
Get Sheet fields by Sheet ID.    [Read more...]
Parameter Description
SheetId
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.
 Get Sheet Rows
Get Sheet rows by Sheet ID.    [Read more...]
 Get Sheet Row by ID(s)
Get a Sheet by ID(s).    [Read more...]
Parameter Description
Row Id(s) - Comma separated (Blank=All Rows) Restrict results to records specified by a comma-separated list of IDs. Max IDs per request controlled by BatchSize property (found in Pagination template)
Row Number(s) - Comma separated list (Blank=All Rows) A comma-separated list of row numbers on which to filter the rows included in the result. Non-existent row numbers are ignored.
 Delete Sheet Rows
Delete rows from a Sheet by row IDs.    [Read more...]
Parameter Description
SheetId
Row Id(s) - Comma separated Restrict results to records specified by a comma-separated list of IDs. Max IDs per request controlled by BatchSize property (found in Pagination template)
Ignore If Rows Not Found If set to false and any of the specified row Ids are not found, no rows are deleted, and the 'not found' error is returned.
Option Value
true true
false false
 Add Sheet Rows
Add rows to a Sheet.    [Read more...]
Parameter Description
Add Row at Specific Location (Default=toBottom)
Option Value
"toBottom": true "toBottom": true
"toTop": true "toTop": true
"parentId": 1231234567 "parentId": 1231234567
"siblingId": 1231234567 "siblingId": 1231234567
Allow Partial Success (Default=False) When specified with a value of true, enables partial success for this bulk operation. See Partial Success for more information.
Option Value
false false
true true
Override Validation (Default=False) You may use the query string parameter overrideValidation with a value of true to allow a cell value outside of the validation limits. You must specify strict with a value of false to bypass value type checking.
Option Value
false false
true true
 update_sheet_rows
   [Read more...]
 Export Sheet (to PDF, Excel, CSV file)
Export Sheet to CSV, Excel or PDF file.    [Read more...]
Parameter Description
SheetId
 Export Report (to PDF, Excel, CSV file)
Export Report to CSV, Excel or PDF file.    [Read more...]
Parameter Description
ReportId
 Send Report via Email (EXCEL, PDF, or PDF_GANTT format)
Sends the report as a Excel / PDF attachment via email to the designated recipients.    [Read more...]
Parameter Description
ReportId
 Send Sheet via Email (EXCEL, PDF, or PDF_GANTT format)
Sends the sheet as a Excel / PDF attachment via email to the designated recipients.    [Read more...]
Parameter Description
SheetId
 List Reports
Get a list of reports.    [Read more...]
Parameter Description
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
 List Contacts
Get a list of contacts.    [Read more...]
Parameter Description
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
 List Groups
Get a list of groups.    [Read more...]
Parameter Description
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
 Get Contacts
Gets the specified contact.    [Read more...]
Parameter Description
ContactId
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Smartsheet Connector Examples (For ODBC PowerPack)

This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

Tables - Sheets    [Read more...]

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

Tables - Contacts    [Read more...]

SELECT * FROM Contacts --Where Id='abcd1234abc'

Get sheet rows    [Read more...]

This example shows how to query any Smart Sheet by its name. If you have space in the sheet name or column name then use bracket ( [my name] ) or double quotes ("my name") around it.

SELECT Id,RowNumber,[Some Column 1],[Some Column 2] FROM [My Sheet Name] --Where Id='5815807987847044'

Get Sheet Rows by Id(s) (single or multiple)    [Read more...]

This example shows how to list multiple Sheet Rows by its Id(s). Supply Comma Separated List of Row IDs (Upto 100 recommended). You can also supply Row Number(s) instead of ID(s). If you supply both Id(s) and Row Number(s) then only common rows are selected.

SELECT * FROM get_sheet_rows_by_ids 
WITH (
  SheetId=3482072521854852
, Id='1312208360476548,6941707894689668,5815807987847044'
--OR-- (If you supply both Id and RowNumber then only Common Rows selected
--, RowNumber='1,2,100'
)

Get sheet rows by row number(s) (single or multiple)    [Read more...]

This example shows how to list multiple Sheet Rows by its Row Number(s). Supply Comma Separated List of Row Numbers (Upto 100 recommended). You can also supply Row Id instead of Row Number(s). If you supply both Id(s) and Row Number(s) then only common rows are selected.

SELECT * FROM get_sheet_rows_by_ids 
WITH (
  SheetId=3482072521854852
, RowNumber='1,2,100'
--OR-- (If you supply both Id and RowNumber then only Common Rows selected
--, Id='1312208360476548,6941707894689668,5815807987847044'
)

Create a new sheet row    [Read more...]

This example shows how to create a new Sheet Row by calling INSERT statement. Optionally specify location where you like to insert new row (default is at bottom).

INSERT INTO [My Sheet]
  ( [Some Text Number Column], [Some Checkbox Column], [Some Contact List Column], [Some Date Column], [Some PickList Column], [Some Multi PickList Column], [Some Symbol Column] )
VALUES 
  ('Updated at <<FUN_NOW>>', true, 'something@abc.com', '2024-12-31','Not Started','Value2,Value4','Green,Yellow')
/*
WITH(
RowLocation='"toTop": true'  --insert at the top
--OR--
--RowLocation='"siblingId": 1231234567'  --insert after some sibling row id
)			
*/

Update a new sheet row    [Read more...]

This example shows how to update specific columns of a Sheet Row by calling UPDATE statement.

UPDATE [My Sheet]
SET [Some Text Number Column]='Updated - <<FUN_NOW>>',
    [Some Checkbox Column] = true,
    [Some Contact List Column] = 'something@abc.com',
    [Some Date Column] = '<<FUN_NOW>>',
    [Some PickList Column] = 'Not Started',
    [Some Multi PickList Column] = 'Value2,Value4',
    [Some Symbol Column] = 'Green,Yellow'
WHERE Id=7522710866202500		
WITH(Output=1)

Delete sheet row(s) - single or multiple    [Read more...]

This example shows how to delete single or multiple sheet rows by calling DELETE statement. You can supply a single Row Id or a comma-separated list of row Ids (Upto 100 recommended).

DELETE FROM [My Sheet] WHERE Id=7522710866202500 
--WITH(IgnoreRowsNotFound='true' --or false)		
--Or
--DELETE FROM [My Sheet] WHERE Id='7522710866202500,7522710866202501,7522710866202502'
--WITH(IgnoreRowsNotFound='true' --or false)

Export Sheet (as PDF, Excel, CSV)    [Read more...]

This example shows how to export Sheet to PDF, CSV or Excel file). If you export to PDF then you can also supply Paper size.

SELECT * FROM export_sheet WITH(
  SheetId=1592926391979908, 
 ,TargetFilePath='c:\temp\exported_sheet_as_excel_file.xlsx' --or .pdf, .csv   
 ,Format='application/vnd.ms-excel'  --or-- application/pdf  --or-- text/csv
--below Paper Size only valid for PDF
--,PaperSize='LETTER' --or LEGAL, WIDE, ARCHD, A4, A3, A2, A1, A0
)

Export Report (as PDF, Excel, CSV)    [Read more...]

This example shows how to export Report to PDF, CSV or Excel file). If you export to PDF then you can also supply Paper size.

SELECT * FROM export_report WITH(
  ReportId=2972339541069700, 
 ,TargetFilePath='c:\temp\exported_report_as_excel_file.xlsx' --or .pdf, .csv   
 ,Format='application/vnd.ms-excel'  --or-- application/pdf  --or-- text/csv
--below Paper Size only valid for PDF
--,PaperSize='LETTER' --or LEGAL, WIDE, ARCHD, A4, A3, A2, A1, A0
)

Send Report via Email to Users or Groups (as PDF, Excel)    [Read more...]

This example shows how to send Report via Email (PDF or Excel format) to list of emails or groups.

SELECT * FROM send_report_email
WITH(
	  ReportId='2972339541069700'
	, Subject='Test report'
	, Message='This email contains report attachment'
	, CcMe='true'
	, PaperSize='LETTER'
	, SendToEmails='bob@mycompany.com~sam@mycompany.com'
	--OR (Emails or Group only - one allowed)
	--, SendToGroups='10022222001~10333330002'
)

Send Sheet via Email to Users or Groups (as PDF, Excel)    [Read more...]

This example shows how to send Sheet via Email (PDF or Excel format) to list of emails or groups.

SELECT * FROM send_sheet_email
WITH(
	  SheetId='1592926391979908'
	, Subject='Test report'
	, Message='This email contains report attachment'
	, CcMe='true'
	, PaperSize='LETTER'
	, SendToEmails='bob@mycompany.com~sam@mycompany.com'
	--OR (Emails or Group only - one allowed)
	--, SendToGroups='10022222001~10333330002'
)

Download for SSIS Download for Other Apps