Smartsheet Connector
Documentation
Version: 2
Documentation
Endpoint

List Contacts


Name

get_contacts

Description

Get a list of contacts. [API reference]

Related Tables

Contacts

Parameters

Parameter Label Required Options Description
ModifiedSince Modified Since NO
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
PageSize PageSize NO

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
Id DT_WSTR nvarchar(255) 255 False
Name DT_WSTR nvarchar(255) 255 False
Email DT_WSTR nvarchar(255) 255 False
FirstName DT_WSTR nvarchar(255) 255 False
LastName DT_WSTR nvarchar(255) 255 False
If the column you are looking for is missing, consider customizing Smartsheet Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw 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 component to read data or in API Destination component to read/write data:

Read from Contacts table using API Destination

This Endpoint belongs to Contacts table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Smartsheet
Contacts
Select
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

List contacts

SELECT * FROM get_contacts

Tables - Contacts

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

get_contacts endpoint belongs to Contacts 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:

List contacts

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_contacts';

EXEC (@MyQuery) AT [LS_TO_SMARTSHEET_IN_GATEWAY];

Tables - Contacts

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

EXEC (@MyQuery) AT [LS_TO_SMARTSHEET_IN_GATEWAY];

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