This page provides a guide to Establishing a Connection to Smartsheet in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Smartsheet

Establishing a Connection shows how to authenticate to Smartsheet and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Smartsheet through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Smartsheet by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Smartsheet

Smartsheet supports connections via the following authentication methods:

• Using the Personal Access Token

Personal Access Token

Use the personal token to test and to access your own data. To obtain the personal token, follow the steps below:

1. Log into Smartsheet.
2. Click Account and select Personal Settings.
3. Click API Access and use the form to generate new access tokens or manage existing access tokens.

Set the AuthScheme to PersonalAccessToken. You can then set the PersonalAccessToken to the token you generated.

Synch Connections

Before you connect, set the following variables:

• OAuthClientId: The client Id assigned when you registered your custom OAuth application.
• OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Click Connect to Smartsheet to open the OAuth endpoint in your default browser. Log in and grant permissions to the application.

The driver then completes the OAuth process as follows:

• Extracts the access token from the callback URL.
• Obtains a new access token when the old one expires.
• Saves OAuth values so that they persist across connections.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Cloud models the Smartsheet data as an easy-to-use SQL database.

Tables

The data model of the Cloud is dynamic. This means that, when you connect using the Cloud, any changes you make in the Smartsheet UI, such as adding a new table, adding new columns, or changing a column's data type, are automatically included in the schema of the Cloud.

However, some tables and views, such as workspaces and folders, are static. These are defined in schema files, which are simple, text-based configuration files. The static tables and views are prefixed with 'Info_'.

Common tables include:

Table	Description
Info_Sheets	Explore detailed metadata and structure of Smartsheet sheets, including their components like columns, rows, and attachments.
Info_Rows	Retrieve detailed row data, including cells, discussions, and attachments, for enhanced row-level analysis.
Info_Columns	Retrieve metadata and properties of columns in Smartsheet sheets or reports, essential for understanding sheet structures.
Info_Cells	Explore individual cell data in Smartsheet rows, offering granular insights into sheet contents.
Info_Attachments	Retrieve detailed information about Smartsheet attachments, which can be associated with comments, rows, or sheets, providing a comprehensive view of file dependencies.
Info_Comments	Access comments within discussions in Smartsheet, providing insights into collaboration history.
Info_Discussions	Analyze discussion threads, including comments, tied to specific rows or sheets for better communication tracking.
Info_Users	Query user data within an organization for administrative and reporting purposes.
Info_Workspaces	Access workspace-level details, including sheets and folders, for better organizational insights.
Info_Folders	Explore folder structures in Smartsheet, including user-level folders and workspace organization.
Info_Reports	Query Smartsheet reports, providing insights into custom aggregated data across sheets.
Info_Templates	Retrieve Smartsheet template information to streamline the creation of standardized sheets.
Info_Groups	Retrieve group information for enhanced user management and role-based permissions in Smartsheet.
Info_Contacts	Query Smartsheet user contact details, facilitating management of personal and shared connections.
Info_Home	Access items available on the Smartsheet Home tab, offering a centralized view of user-permissible objects.
Info_Favorites	Retrieve a user's favorite items in Smartsheet, helping prioritize frequently accessed content.
Info_ServerInformation	Access Smartsheet server information and application constants, useful for API integrations.
Info_CellHistory	Access the historical changes of specific cells in Smartsheet, enabling detailed audit and tracking capabilities.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including managing sheets and attachments, and retrieving OAuth credentials.

API Restrictions

The Cloud uses the Smartsheet API to process supported filters. The Cloud processes other filters client-side within the Cloud.

You can add hyperlink columns to table schema files generated by the CreateSchema stored procedure.

After generating a schema file from the desired table, add a new column (attr) as follows:

• Set other:columnid to a unique value (any string that isn't already taken by another column).
• Add an other:hyperlink attribute to the column. Set this attribute to the value in the name attribute of the column you want your new hyperlink column to display hyperlinks for.

  These two values must match exactly.

For example, suppose you have this column in your schema file:

<attr name="MyColumnName" xs:type="string" ... other:columnid="5555555555555555"/>

Your new hyperlink column attached to this column should look like this:

<attr name="nameLink" xs:type="string" ... other:columnid="YourUniqueIDHere" other:hyperlink="MyColumnName"/>

The Cloud models the data in Smartsheet as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Smartsheet Tables

Name	Description
Info_Attachments	Read and upload attachments in the sheets of your Smartsheet account.
Info_Columns	Read and write properties of columns in your Smartsheet sheets.
Info_Comments	Read and write comment data on your Smartsheet sheets.
Info_Discussions	Read and write discussions data on your Smartsheet sheets.
Info_Folders	Read and write folders data in your Smartsheet account.
Info_Groups	Read and write groups data in your Smartsheet account.
Info_Users	Read and write users data in your Smartsheet account.
Info_Workspaces	Read and write workspace data in your Smartsheet account.

Read and upload attachments in the sheets of your Smartsheet account.

Table Specific Information

SELECT

Queries on this table may be slow if your account contains many sheets. To improve performance, specify SheetId. You can also use DiscussionId, RowId, or CommentId to retrieve attachments for the related object.

Retrieve all attachments from all sheets.

SELECT * FROM Info_Attachments

Retrieve all attachments in a specific sheet.

SELECT * FROM Info_Attachments WHERE SheetId = '2940085806098308'

Retrieve all attachments in a specific discussion.

SELECT * FROM Info_Attachments WHERE SHEETId = '2940085806098308' AND DiscussionId = '8206230771525508'

Retrieve all attachments in a specific row of a sheet.

SELECT * FROM Info_Attachments WHERE SheetId = '2940085806098308' AND RowId = '6773684447799172'

Retrieve all attachments in a specific comment of a sheet.

SELECT * FROM Info_Attachments WHERE SheetId = '2940085806098308' AND CommentId = '1322606759569284'

Retrieve details of a specific attachment in a sheet.

SELECT * FROM Info_Attachments WHERE SheetId = '2940085806098308' AND Id = '3053958945105796'

INSERT

You can create an attachment in:

• A sheet. In this case, the SheetId column is required.
• A row in a sheet. In this case, the SheetId and RowId columns are required.
• A comment in a sheet. In this case, the SheetId and CommentId columns are required.

The Name column is required in every case. Other required columns vary depending on the type of attachment you are creating. Refer to the query examples below.

INSERT INTO Info_Attachments (SheetId, Name, AttachmentType, URL) VALUES ('2940085806098308', 'Link Attachment', 'LINK', 'https://cdata.com')
INSERT INTO Info_Attachments (SheetId, RowId, Name, AttachmentType, AttachmentSubType, URL) VALUES ('2940085806098308', '6773684447799172', 'Sheet Attachment', 'GOOGLE_DRIVE', 'SPREADSHEET', 'https://docs.google.com/spreadsheets/d/xxxx_yyyy/edit?usp=drive_link')

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The unique identifier of the attachment.
Name	String	False		The name of the attachment.
Url	String	False		The temporary URL of the attachment.
UrlExpiresInMillis	Long	True		The temporary URL time to live for the attachment.
AttachmentType	String	False		The attachment type. Possible values are: 'FILE', 'GOOGLE_DRIVE', 'LINK', 'BOX_COM', 'DROPBOX', 'EVERNOTE', and 'EGNYTE'.
AttachmentSubType	String	False		The attachment subtype, valid only for either 'GOOGLE_DRIVE' attachments or 'EGNYTE' attachments. Possible values for 'GOOGLE_DRIVE' attachments: 'DOCUMENT', 'SPREADSHEET', 'PRESENTATION', 'PDF', 'DRAWING'. Possible values for 'EGNYTE' attachments: 'FOLDER'.
CreatedAt	Timestamp	True		A timestamp of when the attachment was originally added.
UserId	String	True		The unique identifier of the user who created the attachment.
UserEmail	String	True		The email address of the user who created the attachment.
UserName	String	True		The full name of the user who created the attachment.
MimeType	String	True		Attachment MIME type. For example 'PNG'.
ParentType	String	True		The type of the object the attachment belongs to. Possible values: 'SHEET', 'ROW', or 'COMMENT'.
ParentId	String	True		The unique identifier of the object the attachment belongs to.
SizeInKb	Long	True		The size of the file, if the attachment is a file.
SheetId	String	False		The Id of the sheet.
RowId	String	False		The Id of the row.
DiscussionId	String	True		The Id of the discussion.
CommentId	String	False		The Id of the comment.
Description	String	False		The description of the attachment.

Read and write properties of columns in your Smartsheet sheets.

Table-specific Information

SELECT

This table returns details for columns in a specified sheet. The SheetId column is always required in the criteria.

Retrieve all columns in a sheet.

SELECT * FROM Info_Columns WHERE SheetId = '568679927703428'

Retrieve details of a specific column in the sheet.

SELECT * FROM Info_Columns WHERE SheetId = '568679927703428' AND Id = '1967782344478596'

INSERT

You can create a new column in the sheet by providing the SheetId, Index, Title, and Type properties as shown in the example query below.

INSERT INTO Info_Columns (SheetId, Index, Title, Type) VALUES ('568679927703428', 1, 'Test Column 1', 'TEXT_NUMBER')

UPDATE

You can update the properties of a column in the sheet by specifying the SheetId and Id columns in the criteria as shown in the example query below.

UPDATE Info_Columns SET Index = 3, Title = 'Transportation', Type = 'PICKLIST', OptionsAggregate = '["ship", "motorcycle", "airplane"]', Hidden = false, Width = 30, Locked = false, LockedForUser = false WHERE SheetId = '568679927703428' AND Id = '1967782344478596'

DELETE

You can delete one of the columns in the sheet by specifying the SheetId and Id columns in the criteria as shown in the example query below.

DELETE FROM Info_Columns WHERE SheetId = '568679927703428' AND Id = '1967782344478596'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The unique identifier for the column, used to reference it programmatically.
Index	Integer	False		The numeric position of the column in the sheet, starting at 0 for the first column.
Title	String	False		The displayed name of the column, as shown in the Smartsheet interface.
Primary	Boolean	True		Indicates whether this column is the primary column, which typically contains key identifiers or names for rows.
Type	String	False		The functional data type of the column, determining how data is stored and validated. The allowed values are TEXT_NUMBER, CHECKBOX, DATE, DATETIME, ABSTRACT_DATETIME, PICKLIST, MULTI_PICKLIST, CONTACT_LIST, MULTI_CONTACT_LIST, DURATION, PREDECESSOR.
OptionsAggregate	String	False		A list of selectable options for the column, applicable for columns like dropdowns or picklists.
ContactOptions	String	False		Array of the contact options available for the column.
Hidden	Boolean	False		Indicates whether the column is hidden in the Smartsheet interface.
Symbol	String	False		Represents visual markers or indicators used in the column, with values varying by column type (for example, checkboxes, picklists). The allowed values are ARROWS_3_WAY, ARROWS_4_WAY, ARROWS_5_WAY, DECISION_SHAPES, DECISION_SYMBOLS, DIRECTIONS_3_WAY, DIRECTIONS_4_WAY, EFFORT, HARVEY_BALLS, HEARTS, MONEY, PAIN, PRIORITY, PRIORITY_HML, PROGRESS, RYG, RYGB, RYGG, SIGNAL, SKI, STAR_RATING, VCR, WEATHER.
ColumnType	String	False		The system-defined column type. The allowed values are AUTO_NUMBER, CREATED_BY, CREATED_DATE, MODIFIED_BY, MODIFIED_DATE.
TagsAggregate	String	True		Defines system tags for the column, used to indicate roles in features like Gantt charts or calendars (for example, 'gantt_duration').
Width	Integer	False		The pixel width used to display the column in the sheet's user interface.
Format	String	False		The applied formatting settings for the column, such as text alignment or date format.
FilterType	String	True		Specifies the type of filter applied to the column, with options such as 'list' for predefined values or 'custom' for user-defined filters.
Locked	Boolean	False		Indicates whether the column is locked, preventing edits by all users except the owner or admin.
LockedForUser	Boolean	False		Indicates whether the column is locked for the current user based on their permissions.
SheetId	String	False		The unique identifier of the sheet to which this column belongs.

Read and write comment data on your Smartsheet sheets.

Table-Specific Information

SELECT

This table returns details for comments in a sheet. The SheetId column is always required and must be specified in the criteria.

Retrieve all comments from a sheet.

SELECT * FROM Info_Comments WHERE SheetId = '2940085806098308';
SELECT * FROM Info_Comments WHERE SheetId IN ('2940085806098308', '8075134644473732');

Retrieve all comments from a specific discussion in the sheet.

SELECT * FROM Info_Comments WHERE SheetId = '2940085806098308' AND DiscussionId = '8206230771525508'

Retrieve a specific comment in the sheet.

SELECT * FROM Info_Comments WHERE SheetId = '2940085806098308' AND Id = '1322606759569284'

INSERT

You can insert a comment to a discussion by providing the SheetId, DiscussionId and Text columns.

INSERT INTO Info_Comments (SheetId, DiscussionId, Text) VALUES ('568679927703428', '4661021235275652', 'This is a comment 3')

UPDATE

You can update the text of a comment in the sheet by specifying the SheetId and Id columns in the criteria as shown in the example query below.

UPDATE Info_Comments SET Text = 'My Comment.' WHERE SheetId = '2736916857677700' AND Id = '3641651486822276'

DELETE

You can delete a comment in the sheet by specifying the SheetId and Id columns in the criteria as shown in the example query below.

DELETE FROM Info_Comments WHERE SheetId = '2736916857677700' AND Id = '3641651486822276'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		A unique identifier assigned to each comment, ensuring it can be referenced distinctly.
Text	String	False		The main content of the comment, containing the user's input or feedback.
UserName	String	True		The name of the user who authored the comment, useful for identifying contributors.
UserEmail	String	True		The email address of the user who authored the comment, allowing for communication or verification.
CreatedAt	Datetime	True		The timestamp indicating when the comment was originally created.
ModifiedAt	Datetime	True		The timestamp indicating the most recent update or edit made to the comment.
AttachmentsAggregate	String	True		A serialized array of attachment objects associated with the comment, providing access to related files.
DiscussionId	String	False		The unique identifier of the discussion thread to which the comment belongs.
SheetId	String	False		The unique identifier of the sheet where the comment is located.

Read and write discussions data on your Smartsheet sheets.

Table-specific Information

SELECT

This table returns a list of discussions. The SheetId column is always required.

Retrieve all discussions in a sheet.

SELECT * FROM Info_Discussions WHERE SheetId = '2940085806098308'

Retrieve all discussions in a specific row of a sheet.

SELECT * FROM Info_Discussions WHERE SheetId = '2940085806098308' AND RowId = '6773684447799172'

Retrieve details of a specified discussion.

SELECT * FROM Info_Discussions WHERE SheetId = '2940085806098308' AND Id = '8206230771525508'

INSERT

You can insert a discussion into a sheet by providing the SheetId and FirstDiscussionComment columns. To add a discussion to a row in the sheet instead, provide the RowId, SheetId, and FirstDiscussionComment columns. Refer to the following query examples:

INSERT INTO Info_Discussions (SheetId, FirstDiscussionComment) VALUES ('568679927703428', 'This is a comment 1')
INSERT INTO Info_Discussions (RowId, SheetId, FirstDiscussionComment) VALUES ('1889077216995204', '568679927703428', 'This is a comment 2')

DELETE

You can delete a discussion in the sheet by specifying the SheetId and Id columns in the criteria as shown in the following example query:

DELETE FROM Info_Discussions WHERE SheetId = '8449165781585796' AND Id = '5354407478988676'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		A unique identifier for the discussion within the Smartsheet.
Title	String	False		The subject or headline of the discussion, providing a brief summary of its content.
AccessLevel	String	False		Indicates the user's permission level for accessing the discussion (for example, view, edit).
ParentId	String	False		The unique identifier of the row or sheet directly associated with the discussion.
ParentType	String	False		Specifies whether the discussion is linked to a row or a sheet. Possible values include: SHEET or ROW.
LastCommentedAt	Datetime	False		The timestamp indicating when the most recent comment was added to the discussion.
LastCommentBy	String	False		The full name of the user who made the latest comment in the discussion.
CreatorName	String	False		The full name of the user who initiated the discussion.
ReadOnly	Boolean	False		Indicates if the discussion is in a read-only state, preventing any modifications.
SheetId	String	False		The unique identifier of the sheet where the discussion is located.
RowId	String	False		The unique identifier of the row associated with the discussion.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
FirstDiscussionComment	String	A special input-only field for adding the initial comment to a new discussion.

Read and write folders data in your Smartsheet account.

Table-specific Information

The RootFolderId pseudo-column and the CreatedAt, ModifiedAt columns are NOT present when UseLegacyAPI is enabled.

SELECT

Retrieve all folders.

SELECT * FROM Info_Folders

Retrieve details for a specific folder.

SELECT * FROM Info_Folders WHERE Id = '2035256120371076'

Retrieve all folders in a specific workspace.

SELECT * FROM Info_Folders WHERE WorkspaceId = '2940085806098308'

Retrieve all folders which are located beneath the folder specified in the folder hierarchy. Only simple criteria like the ones below can be processed for this pseudo-column, otherwise the condition will just be ignored:

SELECT * FROM Info_Folders WHERE RootFolderId = '993868452784004';
SELECT * FROM Info_Folders WHERE RootFolderId = '993868452784004' AND Name = 'MyFolder';

INSERT

You can create a folder inside a workspace or a parent folder by providing either the WorkspaceId column or the ParentFolderId column, and the Name column as shown in the example queries below.

INSERT INTO Info_Folders (WorkspaceId, Name) VALUES ('609757951223684', 'My Folder 1')
INSERT INTO Info_Folders (ParentFolderId, Name) VALUES ('5465554459879300', 'My Folder 1')

UPDATE

You can update folder data by specifying the Id column in the criteria as shown in the example query below.

UPDATE Info_Folders SET Name = 'My Test Folder 1' WHERE Id = '2035256120371076'

DELETE

You can delete a folder by specifying the Id column in the criteria as shown in the example query below.

DELETE FROM Info_Folders WHERE Id = '2035256120371076'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		A system-generated unique identifier for the folder, used to reference it programmatically.
Name	String	False		The user-defined name of the folder, typically representing its content or purpose.
Permalink	String	True		A direct, shareable URL linking to the folder within Smartsheet, useful for quick access.
Favorite	Boolean	True		Indicates whether the user has marked the folder as a favorite for easier navigation in their Home tab.
WorkspaceId	String	False		The unique identifier of the workspace that contains this folder, useful for context within a workspace hierarchy.
ParentFolderId	String	False	Info_Folders.Id	The unique identifier of the parent folder where the folder is stored, indicating its organizational structure.
CreatedAt	Datetime	True		The time when the folder was created.
ModifiedAt	Datetime	True		The time when the folder was last modified.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
RootFolderId	String	The Id of the root folder in which the object resides. Can be used to query the data from only a specific folder (and its subfolders) in the Smartsheet hierarchy.

Read and write groups data in your Smartsheet account.

Table-specific Information

SELECT

Retrieve all groups.

SELECT * FROM Info_Groups

Retrieve details for a specific group.

SELECT * FROM Info_Groups WHERE Id = '2035256120371076'

INSERT

You can create a group by providing the Name column as shown in the following example query:

INSERT INTO Info_Groups (Name, Description, MemberEmails) VALUES ('My Group', 'Testing Group 1.', '[email protected],[email protected]')

UPDATE

You can update group data by specifying the Id column in the criteria as shown in the following example query:

UPDATE Info_Groups SET Name = 'Testing Group 1', Description = 'My Testing Group 1.', OwnerId = '8428447480473476' WHERE Id = '2035256120371076'

DELETE

You can delete a group by specifying the Id column in the criteria as shown in the following example query:

DELETE FROM Info_Groups WHERE Id = '2035256120371076'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		A unique identifier for the group, used as the primary key.
Name	String	False		The descriptive name of the group, typically used for display and identification.
Description	String	False		A brief summary or details about the purpose or function of the group.
Owner	String	True		The email address of the user who owns or administers the group.
OwnerId	String	False		The unique identifier for the user who owns or manages the group.
CreatedAt	Datetime	True		The timestamp indicating when the group was initially created.
ModifiedAt	Datetime	True		The timestamp indicating the most recent update or change made to the group.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
MemberEmails	String	A comma separated list of values containing the emails of the users to add in the group. This column is write-only and can be used only for INSERT statements.

Read and write users data in your Smartsheet account.

Table-specific information

SELECT

Retrieve all users.

SELECT * FROM Info_Users

Retrieve all users in a specific group.

SELECT * FROM Info_Users WHERE GroupId = '2928085806875091'

INSERT

You can create a user in your Smartsheet account by providing the Email, LicensedSheetCreator and Admin columns as shown in the example query below.

INSERT INTO Info_Users (Email, LicensedSheetCreator, Admin) VALUES ('[email protected]', true, true)

UPDATE

You can update user data by providing the Id column in the criteria as shown in the example query below.

UPDATE Info_Users SET FirstName = 'My Test', LastName = 'User 1', Admin = false, GroupAdmin = false, LicensedSheetCreator = false WHERE Id = '8307802553771908'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		A unique identifier assigned to each user, used to differentiate them within the system.
AccountId	String	True		The unique identifier of the account to which the user belongs, establishing account association.
AccountName	String	True		The name of the account associated with the user, providing a human-readable reference.
Email	String	False		The email address registered for the user, used for communication and login purposes.
Name	String	True		The user's full name as it appears in the system, combining first and last name.
FirstName	String	False		The user's first name, typically used in personal greetings and identification.
LastName	String	False		The user's last name, often used for formal identification.
Admin	Boolean	False		Indicates whether the user is a system administrator with privileges to manage accounts and other users.
Locale	String	True		The language and regional settings associated with the user, impacting date formats and other locale-specific elements.
TimeZone	String	True		The user's timezone, used to localize date and time information across the platform.
LicensedSheetCreator	Boolean	False		Indicates if the user holds a license to create and own sheets within the system.
GroupAdmin	Boolean	False		Specifies whether the user can create and manage groups, granting them group admin privileges.
ResourceViewer	Boolean	False		Indicates if the user has access to view resource management features such as workload views.
Status	String	True		The current status of the user within the system. Possible values include: ACTIVE, PENDING, or DECLINED.
GroupId	String	True		The unique identifier of the group to which the user belongs, if applicable.
Company	String	True		The name of the company the user is associated with. Populated only when filtering by user Id.
Department	String	True		The department within the company that the user is part of. Populated only when filtering by user Id.
MobilePhone	String	True		The user's mobile phone number. This field is populated only when filtering by user Id.
LastLogin	String	True		The timestamp of the user's last login. Only populated if the user has logged in and an Id filter is applied.
Role	String	True		The role or position of the user within their organization. Populated only when filtering by user Id.
Title	String	True		The professional title of the user within their organization. Populated only when filtering by user Id.
WorkPhone	String	True		The user's work phone number. This field is populated only when filtering by user Id.
SendEmail	Boolean	False		Whether to send an email to the user's email address once they are created (invited in the Smartsheet account). This columns always returns null in SELECT statements, and is supposed to be used in INSERT statements only.

Read and write workspace data in your Smartsheet account.

Table-specific Information

SELECT

Retrieve all workspaces.

SELECT * FROM Info_Workspaces

Retrieve details for a specific workspace.

SELECT * FROM Info_Workspaces WHERE Id = '2928085806875091'

INSERT

You can create a workspace by providing the Name column as shown in the example query below.

INSERT INTO Info_Workspaces (Name) VALUES ('My Workspace 1')

UPDATE

You can update workspace data by specifying the Id column in the criteria as shown in the example query below.

UPDATE Info_Workspaces SET Name = 'My Test Workspace 1' WHERE Id = '2928085806875091'

DELETE

You can delete a workspace by specifying the Id column in the criteria as shown in the example query below.

DELETE FROM Info_Workspaces WHERE Id = '2928085806875091'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		A globally unique identifier (GUID) for the workspace, used to distinguish it from other workspaces.
Name	String	False		The user-defined name of the workspace, used for organization and identification.
Favorite	Boolean	True		Indicates whether the workspace has been marked as a favorite by the user for quick access.
AccessLevel	String	True		Specifies the permissions level assigned to the user for this workspace, such as Viewer, Editor, or Admin.
Permalink	String	True		A permanent URL that provides a direct link to access the workspace within Smartsheet.

Manage and analyze the Sheet_Content_Calendar, designed for scheduling and content tracking.

Columns

Name	Type	ReadOnly	References	Description
RowId [KEY]	String	False		The unique identifier for a row in the sheet, used to track specific entries in the calendar.
Prio	String	False		Indicates the priority of the content, such as High, Medium, or Low, to assist in scheduling and resource allocation.
Image	String	False		References the associated image file or URL, if any, for the content being planned.
Title & Link	String	False		Represents the title of the content and optionally includes a hyperlink to additional details or resources.
Details	String	False		Provides a detailed description of the content, including key themes or objectives.
Assigned To	String	False		Specifies the person or team responsible for creating or managing the content.
Draft Due	Datetime	False		The deadline for submitting the draft version of the content, ensuring timely reviews.
Draft Status	String	False		Tracks the current progress of the draft, such as In Progress, Completed, or Pending Review.
Approved By	String	False		Records the name of the individual or group that approved the content for publication.
Objective	String	False		Describes the primary goal or purpose of the content, such as increasing engagement or promoting a product.
Target	String	False		Defines the intended audience or demographic for the content.
Media Type	String	False		Categorizes the content by type, such as Article, Video, or Social Media Post.
Art Required	Boolean	False		Indicates whether custom artwork or graphics are needed for the content.
Placement	String	False		Specifies where the content will be published or distributed, such as a website, social media, or print.
Publication Date	Datetime	False		The planned date for the content to go live or be released to the public.
Keywords	String	False		Lists relevant keywords for search optimization or content categorization.
Live	Boolean	False		Indicates whether the content has been published and is currently live.

Track and analyze historical customer order data using the Sheet_Customer_Order_Tracking_History.

Columns

Name	Type	ReadOnly	References	Description
RowId [KEY]	String	False		A unique identifier for each row in the order tracking history, corresponding to the API field for record identification.
PO	String	False		The purchase order number associated with the customer order, retrieved from the API.
PO Date	Datetime	False		The date when the purchase order was created, as specified in the API data.
Ship Date	Datetime	False		The date the order was shipped, sourced from the API field tracking shipment details.
Shipped Via	String	False		The shipping carrier or method used for the order, as recorded in the API.
Invoice Amount	String	False		The total amount billed on the invoice for the order, provided by the API.
Invoice Number	String	False		The unique identifier for the invoice related to the order, matching the API data.
Inv Date	Datetime	False		The date the invoice was generated for the order, as recorded in the API.
Terms	String	False		The payment terms agreed upon for the invoice, as defined in the API.
Paid	Boolean	False		Indicates whether the invoice has been fully paid (true) or not (false), based on API data.
Date Paid	Datetime	False		The date when the invoice payment was completed, if applicable, from the API.
Payment	String	False		Details about the payment method or transaction used for settling the invoice, as sourced from the API.
Check #	String	False		The check number associated with the payment, if a check was used, as recorded in the API.

Plan, budget, and track event-related data with the Sheet_Event_Plan_Budget table.

Columns

Name	Type	ReadOnly	References	Description
RowId [KEY]	String	False		A unique identifier for each row, used to distinguish individual entries within the table.
Task Name	String	False		The name or title of the task associated with this event plan, providing a clear descriptor of its purpose.
Assigned	String	False		The individual or team responsible for completing the task, used to track accountability.
Status	String	False		The current state of the task, such as 'Not Started,' 'In Progress,' or 'Completed.'
Progress	String	False		A visual or numerical representation of how much of the task has been completed.
$ Each	String	False		This column is dynamic and maps to the corresponding field in the API.
Qty	String	False		The quantity of items or resources required for the task, essential for accurate budgeting.
Budget	String	False		The allocated budget for the task, used to monitor financial planning.
Actual	String	False		The actual amount spent on the task, allowing for budget versus actual comparisons.
Comments	String	False		Additional notes or details about the task, providing context or clarification.

Manage and analyze expense reports effectively using the Sheet_Expense_Report table.

Columns

Name	Type	ReadOnly	References	Description
RowId [KEY]	String	False		The unique identifier for each row in the expense report sheet. Corresponds to the Row ID in the Smartsheet API.
Date	Datetime	False		The date associated with the expense entry, formatted as a datetime value.
Description	String	False		A brief description or note about the expense, such as its purpose or details.
Expense Category	String	False		The category to which the expense belongs, such as Travel, Meals, or Office Supplies.
Amount	String	False		The monetary value of the expense, stored as a string for API consistency.
Manager Approved	Boolean	False		Indicates whether the manager has approved this expense (true or false).
Comment	String	False		Additional comments or notes about the expense provided by the user or manager.

Track and manage projects with fixed deadlines using a Gantt-style layout in this Smartsheet table.

Columns

Name	Type	ReadOnly	References	Description
RowId [KEY]	String	False		A unique identifier for each row, used to reference the specific task or item in the API.
At Risk	Boolean	False		Indicates whether the task is at risk of missing its deadline or completion target.
Task Name	String	False		The name or title of the task, used for identifying and tracking work items.
Start Date	Datetime	False		The planned start date and time for the task, critical for scheduling and dependencies.
End Date	Datetime	False		The planned end date and time for the task, representing its deadline or completion target.
Assigned To	String	False		The name or unique identifier of the person or team assigned to complete the task.
Status	String	False		The current status of the task (for example, Not Started, In Progress, Completed).
Duration	String	False		The total time allocated for the task, typically measured in days or hours.
% Complete	String	False		The percentage of the task that has been completed, useful for tracking progress.
Predecessors	String	False		Specifies tasks that must be completed before this task can start, helping to define dependencies.
Comments	String	False		Additional notes or information about the task, often used for collaboration or clarification.

Track and manage job candidate progress and information with the Sheet_Job_Candidate_Tracker table.

Columns

Name	Type	ReadOnly	References	Description
RowId [KEY]	String	False		The unique identifier for each row in the tracker, corresponding to a specific candidate record in the API.
Candidate Name	String	False		The full name of the candidate being tracked in the hiring process.
Next Steps	String	False		Details the upcoming actions or decisions required for the candidate, such as scheduling an interview or extending an offer.
Comments	String	False		Contains notes or remarks from hiring managers or interviewers about the candidate.
Status	String	False		Indicates the current stage of the candidate in the hiring process, such as 'Applied', 'Interviewed', or 'Hired'.
RYG	String	False		Represents a red-yellow-green status indicator to visually track candidate progress or priority.
Start Date	Datetime	False		The proposed or confirmed start date for the candidate, if hired.
Hiring Mgr	String	False		The name of the hiring manager responsible for the candidate's recruitment process.
Referral Source	String	False		Indicates how the candidate was sourced, such as 'Referral', 'Job Board', or 'Career Fair'.
Hire Type	String	False		Specifies the type of hire, such as 'Full-Time', 'Part-Time', 'Contractor', or 'Intern'.
Compensation	String	False		Details the offered or agreed compensation package for the candidate, including salary or hourly rate.

Monitor sales activity by representative and month with the Sheet_Sales_Activity_Tracking_by_Rep_Month table.

Columns

Name	Type	ReadOnly	References	Description
RowId [KEY]	String	False		The unique identifier for each row, dynamically mapped to the corresponding field in the API.
Monthly Metric	String	False		The specific sales metric tracked for the month, dynamically linked to the API field.
Quota	String	False		The assigned sales target or goal for the month, pulled dynamically from the API.
Actual	String	False		The actual sales performance achieved for the month, as recorded in the API.
Percent to Goal	String	False		The percentage of the quota achieved for the month, dynamically calculated and mapped via the API.
Variance	String	False		The difference between the actual sales and the quota, indicating overachievement or shortfall.
Pace	String	False		The rate of progress toward meeting the monthly sales goal, dynamically updated via the API.

Simplify sales tracking using the Sheet_Simple_Sales_Pipeline table for streamlined data management.

Columns

Name	Type	ReadOnly	References	Description
RowId [KEY]	String	False		The unique identifier for each row, corresponding to the unique field in the API.
Status	String	False		Represents the current state of the opportunity, such as Open, Closed, or In Progress.
Company Logo	String	False		Stores the URL or file reference to the company's logo associated with the opportunity.
Opportunity	String	False		The name or identifier of the sales opportunity being tracked.
Contact Name	String	False		Full name of the primary contact person for the opportunity.
Sales Stage	String	False		Indicates the current stage in the sales pipeline, such as Qualification, Proposal, or Negotiation.
Forecast Amount	String	False		The projected revenue amount for the opportunity.
Probability	String	False		Percentage likelihood that the opportunity will be successfully closed.
Weighted Forecast	String	False		Calculated value of Forecast Amount multiplied by the Probability, representing the weighted revenue.
Expected Close Date	Datetime	False		The date by which the opportunity is expected to close.
Sales Rep	String	False		The name of the sales representative responsible for the opportunity.
Next Step	String	False		Describes the next action or task planned to progress the opportunity.

Monitor and track team objectives efficiently using the Sheet_Team_Objectives_Tracker.

Columns

Name	Type	ReadOnly	References	Description
RowId [KEY]	String	False		A unique identifier for each row, corresponding to the Row ID field in the Smartsheet API.
Task Name	String	False		The name or title of the task, used to identify objectives being tracked in the sheet.
Responsible	String	False		The individual or team assigned responsibility for completing the task.
State	String	False		The current status of the task, such as 'Not Started,' 'In Progress,' or 'Completed.'
Due Date	Datetime	False		The deadline for the task, represented as a date and time, used for scheduling and tracking purposes.
Comments	String	False		Additional notes or comments related to the task, providing context or updates for collaborators.

Prioritize and manage team tasks with the Sheet_Team_Task_List_by_Priority table.

Columns

Name	Type	ReadOnly	References	Description
RowId [KEY]	String	False		The unique identifier for each row in the task list, dynamically mapped to the corresponding field in the API.
RYG	String	False		Indicates the red-yellow-green (RYG) priority or status flag for a task, dynamically mapped to the corresponding field in the API.
Task	String	False		The title or name of the task, dynamically mapped to the corresponding field in the API.
Assigned To	String	False		The name or unique identifier of the individual or team responsible for the task, dynamically mapped to the corresponding field in the API.
Reviewed	Boolean	False		A flag indicating whether the task has been reviewed, dynamically mapped to the corresponding field in the API.
Status	String	False		The current status of the task (for example, In Progress, Completed), dynamically mapped to the corresponding field in the API.
Due	Datetime	False		The due date and time for the task, dynamically mapped to the corresponding field in the API.
Notes & Comments	String	False		Additional notes or comments related to the task, dynamically mapped to the corresponding field in the API.

Test and analyze web form data integration using the Sheet_WebFormTest table.

Columns

Name	Type	ReadOnly	References	Description
RowId [KEY]	String	False		A unique identifier for each row, typically used to reference and track specific entries in the web form.
Form Field 1	String	False		Represents the first field in the web form, typically used to collect user input or specific details.
Form Field 2	String	False		Represents the second field in the web form, used to capture additional user-provided information.
Form Date Field	Datetime	False		Stores the date and time associated with the web form submission, providing a timestamp for tracking and analysis.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Smartsheet Views

Name	Description
Info_AttachmentVersions	Read data on the versions of the attachments in your Smartsheet sheets.
Info_CellHistory	Query the available CellHistory of a Cell in Smartsheet.
Info_Cells	Query Smartsheet Cells. A collection of Cells comprises each Row in a Sheet.
Info_Contacts	Query Smartsheet Contacts. A Contact is the personal contact of a User in Smartsheet.
Info_DashboardPublishSettings	Provides the publish status details of Smartsheet dashboards
Info_Dashboards	Query Smartsheet Dashboards.
Info_DashboardShares	Query the Sharing operations of Dashboards.
Info_Favorites	Query Smartsheet Favorites.
Info_Home	Query objects on the Home tab in Smartsheet. The Home tab shows all objects a User has access to.
Info_ReportPublishSettings	Provides publish settings for Smartsheet reports.
Info_Reports	Query Smartsheet Reports.
Info_ReportShares	Query the Sharing operations of Reports.
Info_Rows	Query Rows in a Sheet or Report. Each Row is composed of a collection of Cells, and may optionally contain Discussions and Attachments.
Info_ServerInformation	Query Smartsheet Server Information including application constants.
Info_SheetPublishSettings	Provides publish settings for Smartsheet sheets.
Info_Sheets	Query Smartsheet Sheets. A Sheet can exist in the Sheets folder for the user (Home), in a Folder, or in a Workspace. It is comprised of Columns, Rows, and Cells, and may optionally contain Attachments and Discussions.
Info_SheetShares	Query the Sharing operations of Sheets.
Info_Templates	Query Smartsheet Templates.
Info_WorkspaceShares	Query the Sharing operations of Workspaces.

Read data on the versions of the attachments in your Smartsheet sheets.

Table-specific information

SELECT

Retrieve all attachment versions of an attachment in the sheet.

SELECT * FROM Info_AttachmentVersions WHERE SheetId = '8449165781585796' AND AttachmentId = '2879526696423300'

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of the attachment version.
SheetId	String		The unique identifier of the sheet in which the attachment is located.
AttachmentId	String		The unique identifier of the attachment (Id of the most recent version).
Name	String		The name of the attachment.
MimeType	String		The attachment MIME type (e.g. 'PNG').
CreatedAt	Timestamp		The time when the attachment was created.
ParentId	String		The unique identifier of the object to which the attachment belongs to.
ParentType	String		The type of object to which the attachment belongs to. The allowed values are SHEET, ROW, COMMENT.
UserName	String		The full name of the user who created the attachment.
UserEmail	String		The email address of the user who created the attachment.
URL	String		The temporary URL of the attachment.
SizeInKB	Long		The size of the attachment in kilobytes.
Description	String		The description of the attachment.

Access the historical changes of specific cells in Smartsheet, enabling detailed audit and tracking capabilities.

Table Specific Information

Select

To get data from this view a SheetId, RowId, and ColumnId are always required.

Retrieve Cell History.

SELECT * FROM Info_CellHistory WHERE SheetId = '2940085806098308' AND RowId = '6773684447799172' AND ColumnId = '7999197812156292'

Columns

Name	Type	References	Description
Value	String		The most recent content in the cell, which could include text, numbers, or the result of a formula. This value represents the cell's current state.
ModifiedAt	Datetime		The date and time when the cell was last updated. This helps in identifying the most recent activity in the cell.
EditorName	String		The full name of the user who made the latest changes to the cell. This provides clarity about who is responsible for updates.
EditorEmail	String		The email address of the user who last modified the cell, allowing for easy communication or audit purposes.
SheetId	String		A unique identifier for the sheet containing this cell. This links the cell to its corresponding sheet in Smartsheet.
RowId	String		A unique identifier for the row in which this cell is located. This helps in pinpointing and managing specific rows.
ColumnId	String		A unique identifier for this cell's column enables efficient column-based operations or analysis.

Explore individual cell data in Smartsheet rows, offering granular insights into sheet contents.

Table Specific Information

Select

This view returns details for Cells of a specified Row. The SheetId and RowId parameters are always required.

Retrieve Cells.

SELECT * FROM Info_Cells WHERE SheetId = '2940085806098308' AND RowId = '6773684447799172'

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of the column that contains the cell. This is a reference to the parent column in the sheet's schema.
Value	String		The actual content of the cell, which can be a string, number, or boolean, representing the cell's primary data.
DisplayValue	String		The formatted version of the cell's content as displayed to the user in the Smartsheet UI, reflecting applied formats and rules.
ColumnType	String		The type of data or content allowed in the column (for example, text, date, dropdown) as defined in the column's schema.
Formula	String		The formula applied to the cell, if any, used to compute dynamic values based on other cell references.
Format	String		Descriptor specifying the visual formatting of the cell, such as text style, color, or alignment.
ConditionalFormat	String		The formatting applied to the cell based on conditional rules set at the column or sheet level.
Strict	Boolean		Indicates if strict parsing rules are applied to the cell's value. Defaults to true; set to false for more lenient value handling.
SheetId	String		The unique identifier of the sheet to which this cell belongs.
RowId	String		The unique identifier of the row containing this cell, representing its position in the sheet.

Query Smartsheet user contact details, facilitating management of personal and shared connections.

Table Specific Information

Select

This view returns details for Contacts.

Retrieve Contacts.

SELECT * FROM Info_Contacts

Retrieve details of a specified Contact.

SELECT * FROM Info_Contacts WHERE Id = '1322606759569284'

Columns

Name	Type	References	Description
Id [KEY]	String		A unique identifier assigned to each contact, used to differentiate them within the database.
Name	String		The full name of the contact, typically including both first and last names.
Email	String		The primary email address associated with the contact, used for communication purposes.

Provides the publish status details of Smartsheet dashboards

Columns

Name	Type	References	Description
DashboardId [KEY]	String		The unique identifier of the dashboard whose publish status is being retrieved.
ReadOnlyFullEnabled	Boolean		Indicates whether the 'Read-Only Full' version of the dashboard is published, allowing viewers to interact with widgets and use shortcuts.
ReadOnlyFullUrl	String		The URL for accessing the 'Read-Only Full' view of the published dashboard. Only returned if 'ReadOnlyFullEnabled' is true.
ReadOnlyFullAccessibleBy	String		Specifies who can access the 'Read-Only Full' view of the published dashboard. Possible values: ALL (anyone with the link), ORG (members of the owner's organization), SHARED (users shared to the item).

Query Smartsheet Dashboards.

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of the Dashboard.
Name	String		The name of the Dashboard.
AccessLevel	String		The access level for the user or group on the shared object.
Permalink	String		URL that represents a direct link to the Dashboard in Smartsheet.
CreatedAt	Datetime		Time that the share was created.
ModifiedAt	Datetime		Time that the share was modified.
WorkspaceId	String		Id of workspace where this Dashboard is located
FolderId	String		The Id of the folder.

Query the Sharing operations of Dashboards.

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of this share.
DashboardId [KEY]	String		The Id of the Dashboard.
Type	String		The type of this share. Possible values: USER or GROUP.
UserId	String		The user Id for a user share.
GroupId	String		The group Id of a group share.
Email	String		The email address for a user share.
Name	String		The full name for a user share where the user is also a contact. The group name for a group share.
AccessLevel	String		The access level for the user or group on the shared object.
Scope	String		The scope of the share (ITEM or WORKSPACE).
CreatedAt	Datetime		Time that the share was created.
ModifiedAt	Datetime		Time that the share was modified.

Retrieve a user's favorite items in Smartsheet, helping prioritize frequently accessed content.

Table Specific Information

Select

This view returns a list of Favorite objects.

Retrieve all Favorite objects.

SELECT * FROM Info_Favorites

Columns

Name	Type	References	Description
ObjectId	String		A unique identifier for the item that has been marked as a favorite. For favorite items of the type 'template,' only private sheet-type template IDs are permitted.
Type	String		Specifies the category of the favorite item. Possible values include 'workspace' for a collection of sheets and reports, 'folder' for a grouping of related items, 'sheet' for individual sheets, 'report' for consolidated data views, and 'template' for reusable sheet designs.

Access items available on the Smartsheet Home tab, offering a centralized view of user-permissible objects.

Table Specific Information

This view is present in the data model only when UseLegacyAPI is enabled.

Select

Retrieve all objects located on the Home tab:

SELECT * FROM Info_Home

Columns

Name	Type	References	Description
SheetsAggregate	String		An array containing details about all sheet objects associated with the home information.
FoldersAggregat	String		An array containing details about all folder objects within the current context of the home environment.
ReportsAggregat	String		An array containing details about all report objects, providing insights into shared or owned reports in the home scope.
TemplatesAggregat	String		An array containing details about all template objects available within the home context, used for creating new sheets.
WorkspacesAggregat	String		An array containing details about all workspace objects, representing collaborative spaces within the home environment.

Provides publish settings for Smartsheet reports.

Columns

Name	Type	References	Description
ReportId [KEY]	String		Unique identifier of the report whose publish settings are being retrieved.
ReadOnlyFullEnabled	Boolean		Indicates whether the report is published in a rich, read-only format with features like downloading attachments and discussions.
ReadOnlyFullUrl	String		URL for accessing the 'Read-Only Full' view of the published report; available only if ReadOnlyFullEnabled is true.
ReadOnlyFullAccessibleBy	String		Specifies who can access the 'Read-Only Full' view: ALL (anyone with the link), ORG (members of the report owner's organization), or SHARED (users shared to the item); returned only if ReadOnlyFullEnabled is true.
ReadOnlyFullDefaultView	String		Indicates the default view for the 'Read-Only Full' published report: CALENDAR, CARD, or GRID.

Query Smartsheet reports, providing insights into custom aggregated data across sheets.

Table Specific Information

The RootFolderId pseudo-column is NOT present when UseLegacyAPI is enabled.

Select

Retrieve all Reports.

SELECT * FROM Info_Reports

Retrieve Reports located in a specific Workspace.

SELECT * FROM Info_Reports WHERE WorkspaceId = '6773684447799172'

Retrieve Reports located in a specific Folder.

SELECT * FROM Info_Reports WHERE FolderId = '6773684447799172'

Retrieve Reports which are located beneath the folder specified in the folder hierarchy. Only simple criteria like the ones below can be processed for this pseudo-column, otherwise the condition will just be ignored:

SELECT * FROM Info_Reports WHERE RootFolderId = '993868452784004';
SELECT * FROM Info_Reports WHERE RootFolderId = '993868452784004' AND Name = 'MyReport';

Columns

Name	Type	References	Description
Id [KEY]	String		A unique identifier for the report, used as the primary key for reference.
Name	String		The descriptive name of the report, typically used to identify its purpose or content.
FolderId	String		The unique identifier of the folder where the report is stored, indicating its organizational structure.
WorkspaceId	String		The unique identifier of the workspace containing this report, representing its broader context and ownership.
Permalink	String		URL that represents a direct link to the report in Smartsheet.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
RootFolderId	String		The Id of the root folder in which the object resides. Can be used to query the data from only a specific folder (and its subfolders) in the Smartsheet hierarchy.

Query the Sharing operations of Reports.

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of this share.
ReportId [KEY]	String		The Id of the report.
Type	String		The type of this share. Possible values: USER or GROUP.
UserId	String		The user Id for a user share.
GroupId	String		The group Id of a group share.
Email	String		The email address for a user share.
Name	String		The full name for a user share where the user is also a contact. The group name for a group share.
AccessLevel	String		The access level for the user or group on the shared object.
Scope	String		The scope of the share (ITEM or WORKSPACE).
CreatedAt	Datetime		Time that the share was created.
ModifiedAt	Datetime		Time that the share was modified.

Retrieve detailed row data, including cells, discussions, and attachments, for enhanced row-level analysis.

Table Specific Information

Select

This view returns a list of Sheet Rows. The SheetId parameter is always required.

Retrieve all Rows of a Sheet.

SELECT * FROM Info_Rows WHERE SheetId = '2940085806098308'

Retrieve details of a specified Row.

SELECT * FROM Info_Rows WHERE SheetId = '2940085806098308' AND Id = '8206230771525508'

Columns

Name	Type	References	Description
Id [KEY]	String		A unique identifier for the row, assigned by Smartsheet. This value is guaranteed to be unique within the sheet.
RowNumber	Integer		The sequential number of the row within the sheet, starting at 1. Useful for referencing rows in a user-friendly way.
Version	Integer		Indicates the current version of the sheet. This number increments each time a modification is made to the sheet.
FilteredOut	Boolean		Indicates if this row is excluded from view by an applied column filter. True means the row is hidden; False means it is visible.
InCriticalPath	Boolean		True if this row is part of the critical path in a project sheet with dependencies enabled. Useful for project planning and scheduling.
Locked	Boolean		Indicates if the row has been locked by the sheet owner or admin to prevent changes.
LockedForUser	Boolean		Indicates if the row is locked for the current user based on their permissions.
Expanded	Boolean		Shows whether the row is currently expanded to reveal child rows or collapsed to hide them.
AccessLevel	String		Defines the user's access permissions to the sheet containing this row (for example, Viewer, Editor, Admin).
Format	String		Describes the visual format applied to the row, such as font color, background color, and text styles.
ConditionalFormat	String		Specifies the visual format applied to the row due to a conditional formatting rule.
CreatedAt	Datetime		The timestamp when the row was initially created in Smartsheet.
ModifiedAt	Datetime		The timestamp when the row was last modified. Helps track changes over time.
Permalink	String		A permanent URL linking directly to this row in Smartsheet for easy access.
ParentId	String		The unique identifier of the parent row, if this row is part of a hierarchical structure.
SiblingId	String		The unique identifier of the previous sibling row at the same hierarchical level. Useful for determining row order.
ToTop	Boolean		A flag indicating if the row should be moved or inserted at the top of the sheet.
ToBottom	Boolean		A flag indicating if the row should be moved or inserted at the bottom of the sheet.
Above	Boolean		A flag indicating if the row should be moved or inserted above another specified row.
SheetId	String		The unique identifier of the sheet to which this row belongs.

Access Smartsheet server information and application constants, useful for API integrations.

Table Specific Information

Select

Retrieve Server Information:

SELECT * FROM Info_ServerInformation

Columns

Name	Type	References	Description
SupportedLocales	String		An array of locale strings supported by Smartsheet, used for regional and language settings.
FormatsDefaults	String		Describes default format settings for display in the Smartsheet Web application when no custom format values are applied.
FontFamily	String		Defines the font families available, including additional metadata about each font.
FontSize	String		Specifies font sizes in points, representing the height of characters in text.
Bold	String		Indicates if text is bolded. Possible values include 'none' (not bolded) and 'on' (bolded).
Italic	String		Indicates if text is italicized. Possible values include 'none' (not italicized) and 'on' (italicized).
Underline	String		Indicates if text is underlined. Possible values include 'none' (no underline) and 'on' (underlined).
Strikethrough	String		Indicates if text has a strikethrough effect. Possible values include 'none' (no strikethrough) and 'on' (strikethrough applied).
HorizontalAlign	String		Defines horizontal text alignment within cells. Possible values include 'none', 'left', 'center', 'right'.
VerticalAlign	String		Defines vertical text alignment within cells. Possible values include 'top', 'middle', 'bottom'. The default value is 'top'.
Color	String		Specifies text and background color in hex format. If 'none', applications use default colors (for example, Black for text, White for background).
Currency	String		Lists supported currency codes (for example, USD, EUR) along with their respective symbols.
ThousandsSeparator	String		Determines if numbers display a thousands separator (for example, 1,000). Possible values include 'none' (no separator) and 'on' (separator applied).
NumberFormat	String		Specifies how numbers are formatted. Possible values include 'none', 'NUMBER', 'CURRENCY', 'PERCENT'.
TextWrap	String		Indicates whether text wraps within the cell. Possible values include 'none' (no wrap) and 'on' (text wraps).

Provides publish settings for Smartsheet sheets.

Columns

Name	Type	References	Description
SheetId [KEY]	String		Unique identifier of the Smartsheet sheet.
ReadOnlyFullEnabled	Boolean		Indicates if the 'Read-Only Full' view, with attachments and discussions, is published.
ReadOnlyFullUrl	String		URL for the 'Read-Only Full' view; available if ReadOnlyFullEnabled is true.
ReadOnlyFullAccessibleBy	String		Specifies who can access the 'Read-Only Full' view: ALL (anyone with the link), ORG (organization members), or SHARED (shared users); available if ReadOnlyFullEnabled is true.
ReadOnlyFullDefaultView	String		Default view mode for 'Read-Only Full' view: CALENDAR, CARD, or GRID.
ReadOnlyLiteEnabled	Boolean		Indicates if a lightweight 'Read-Only Lite' view, without attachments and discussions, is published.
ReadOnlyLiteUrl	String		URL for the 'Read-Only Lite' HTML view; available if ReadOnlyLiteEnabled is true.
ReadOnlyLiteSslUrl	String		SSL URL for the 'Read-Only Lite' view.
ReadWriteEnabled	Boolean		Indicates if the 'Edit by Anyone' view, with editing capabilities, is published.
ReadWriteUrl	String		URL for the 'Edit by Anyone' view; available if ReadWriteEnabled is true.
ReadWriteAccessibleBy	String		Specifies who can access the 'Edit by Anyone' view: ALL (anyone with the link), ORG (organization members), or SHARED (shared users); available if ReadWriteEnabled is true.
ReadWriteDefaultView	String		Default view mode for 'Edit by Anyone' view: CALENDAR, CARD, or GRID.
IcalEnabled	Boolean		Indicates if an iCal feed is available for the sheet's calendar.
IcalUrl	String		URL for the iCal feed of the sheet's calendar; available if IcalEnabled is true.

Explore detailed metadata and structure of Smartsheet sheets, including their components like columns, rows, and attachments.

Table Specific Information

The RootFolderId pseudo-column is NOT present when UseLegacyAPI is enabled.

Select

Retrieve all Sheets.

SELECT * FROM Info_Sheets

Retrieve Sheets located in a specific Folder.

SELECT * FROM Info_Sheets WHERE FolderId = '2928085806875091'

Retrieve Sheets located in a specific Workspace.

SELECT * FROM Info_Sheets WHERE WorkspaceId = '1928085806875098'

Retrieve Sheets which are located beneath the folder specified in the folder hierarchy. Only simple criteria like the ones below can be processed for this pseudo-column, otherwise the condition will just be ignored:

SELECT * FROM Info_Sheets WHERE RootFolderId = '993868452784004';
SELECT * FROM Info_Sheets WHERE RootFolderId = '993868452784004' AND Name = 'MySheet';

Columns

Name	Type	References	Description
Id [KEY]	String		A unique identifier assigned to the sheet, used for referencing it programmatically or in APIs.
Name	String		The descriptive name of the sheet, visible to users in the Smartsheet interface.
Owner	String		The email address of the user who owns the sheet and has primary control over its permissions and content.
OwnerId	String		The unique identifier of the user who owns the sheet, used for internal user management.
Permalink	String		A permanent, shareable URL that provides direct access to the sheet in Smartsheet.
SourceId	String		The unique identifier of the original sheet or template from which this sheet was created, useful for tracing its origin.
SourceType	String		Indicates whether the source object for this sheet was a 'sheet' or a 'template', helping to categorize its origin.
CreatedAt	Datetime		The timestamp indicating when the sheet was first created in Smartsheet.
ModifiedAt	Datetime		The timestamp of the most recent modification made to the sheet's content or properties.
Version	Long		A revision number incremented with each change made to the sheet, useful for tracking updates.
TotalRowCount	Long		The total number of rows currently present in the sheet, reflecting its data capacity or usage. Values for this column are retrieved only when filtering with the Id column.
AccessLevel	String		The permission level of the current user for this sheet, such as 'viewer', 'editor', or 'admin'.
ReadOnly	Boolean		Indicates if the sheet is in read-only mode, typically due to an expired trial or restricted permissions.
GanttEnabled	Boolean		Specifies whether the Gantt chart feature is enabled for this sheet, allowing project timelines to be visualized.
DependenciesEnabled	Boolean		Shows if dependency tracking is active, used for managing task relationships and schedules.
ResourceManagementEnabled	Boolean		Indicates if resource management tools are enabled, supporting workload and capacity planning.
Favorite	Boolean		Indicates whether the user has marked this sheet as a favorite, making it easier to locate in their Home tab.
ShowParentRowsForFilters	Boolean		Specifies if the 'Show Parent Rows' option is enabled for filtering, helping to display hierarchical context.
FromId	String		The unique identifier of the template from which the sheet was originally created, used for template-based organization.
WorkspaceId	String		The unique identifier of the workspace where the sheet is stored, aiding in categorization and collaboration.
FolderId	String		The unique identifier of the folder containing the sheet, for better organization within Smartsheet.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
RootFolderId	String		The Id of the root folder in which the object resides. Can be used to query the data from only a specific folder (and its subfolders) in the Smartsheet hierarchy.

Query the Sharing operations of Sheets.

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of this share.
SheetId [KEY]	String		The Id of the sheet.
Type	String		The type of this share. Possible values: USER or GROUP.
UserId	String		The user Id for a user share.
GroupId	String		The group Id of a group share.
Email	String		The email address for a user share.
Name	String		The full name for a user share where the user is also a contact. The group name for a group share.
AccessLevel	String		The access level for the user or group on the shared object.
Scope	String		The scope of the share (ITEM or WORKSPACE).
CreatedAt	Datetime		Time that the share was created.
ModifiedAt	Datetime		Time that the share was modified.

Retrieve Smartsheet template information to streamline the creation of standardized sheets.

Table Specific Information

The RootFolderId pseudo-column is NOT present when UseLegacyAPI is enabled.

Select

By default this view returns all Templates created by the user. If the Scope filter is set to 'public' , the public templates will be returned.

Retrieve all Templates.

SELECT * FROM Info_Templates

Retrieve all other public Templates.

SELECT * FROM Info_Templates WHERE Scope = 'public'

Retrieve Templates located on a specific folder.

SELECT * FROM Info_Templates WHERE FolderId = '2928085806875091'

Retrieve Templates located on a specific Workspace.

SELECT * FROM Info_Templates WHERE WorkspaceId = '1928085806875098'

Retrieve Templates which are located beneath the folder specified in the folder hierarchy. Only simple criteria like the ones below can be processed for this pseudo-column, otherwise the condition will just be ignored:

SELECT * FROM Info_Templates WHERE RootFolderId = '993868452784004';
SELECT * FROM Info_Templates WHERE RootFolderId = '993868452784004' AND Name = 'MyTemplate';

Columns

Name	Type	References	Description
Id [KEY]	String		A unique identifier assigned to each template, ensuring it can be distinctly referenced.
Name	String		The user-defined name of the template, used for display and identification purposes.
Description	String		A detailed overview or summary of the template's purpose and contents.
AccessLevel	String		Defines the level of user permissions on the template, such as 'read-only' or 'editor'.
Permalink	String		A permanent, unique URL linking directly to the template for easy sharing or access.
Scope	String		The scope of the template. Possible values: 'public' for templates accessible to all users, and 'user' for templates created and accessible only by the logged-in user. The allowed values are public, user.
FolderId	String		The unique identifier of the folder where the template is stored, helping to organize templates.
WorkspaceId	String		The unique identifier of the workspace containing the template, useful for multi-user collaboration.
TemplateType	String		Type of template. Only applicable to public templates. Possible values: 'report', 'sheet'.
Categories	String		Indicates whether the template is blank. Only applicable to public templates.
Tags	String		List of search tags for this template. Only applicable to non-blank public templates.
Locale	String		Indicates the language and region settings for the template, such as 'en-US' or 'fr-FR'.
Blank	Boolean		Indicates whether the template is blank. Only applicable to public templates.
GlobalTemplate	String		Type of global template. Only applicable to blank public templates. Possible values: 'BLANK_SHEET', 'PROJECT_SHEET', 'TASK_LIST'.
Image	String		The URL pointing to an image representing the template, often used in visual displays or previews.
LargeImage	String		URL to the large preview image for this template. Only applicable to non-blank public templates.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
RootFolderId	String		The Id of the root folder in which the object resides. Can be used to query the data from only a specific folder (and its subfolders) in the Smartsheet hierarchy.

Query the Sharing operations of Workspaces.

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of this share.
WorkspaceId [KEY]	String		The Id of the workspace.
Type	String		The type of this share. Possible values: USER or GROUP.
UserId	String		The user Id for a user share.
GroupId	String		The group Id of a group share.
Email	String		The email address for a user share.
Name	String		The full name for a user share where the user is also a contact. The group name for a group share.
AccessLevel	String		The access level for the user or group on the shared object.
Scope	String		The scope of the share (ITEM or WORKSPACE).
CreatedAt	Datetime		Time that the share was created.
ModifiedAt	Datetime		Time that the share was modified.

Analyze sales activities and team objectives using a dedicated Smartsheet report for performance tracking.

Columns

Name	Type	References	Description
Sheet Name	String		The name of the sheet representing sales activity and team objectives, providing a top-level identifier for the report.
Primary	String		The primary column, typically used as a key identifier or main reference point for each row in the sales activity and objectives table.
Responsible	String		Indicates the individual or team responsible for the associated sales activity or objective, helping to assign accountability.
Pace	String		Represents the pace at which sales activities are progressing, helping track velocity against goals.
Percent to Goal	String		Shows the percentage completion towards the specified sales goals, aiding in performance tracking.
Due Date	Datetime		The target completion date for the sales activity or objective, allowing for effective time management and planning.
Actual	String		Records the actual performance or results achieved in the sales activity, enabling comparison with the target goals.
Quota	String		Specifies the target or quota assigned for the sales activity, serving as a benchmark for performance evaluation.
Comments	String		Provides additional notes or remarks related to the sales activity or objectives, offering context or insights for each entry.
State	String		Denotes the current status or condition of the sales activity, such as 'In Progress,' 'Completed,' or 'Pending.'

Access detailed task and event data within a Smartsheet report for efficient planning and monitoring.

Columns

Name	Type	References	Description
RowId [KEY]	String		A unique identifier for each row in the sheet, corresponding to the RowId field in the Smartsheet API.
Sheet Name	String		The name of the sheet this row belongs to, as retrieved from the Smartsheet API.
Primary	String		The primary column for the sheet, used to identify the key attribute of each row.
Assigned To	String		The individual or team responsible for the task or event, as designated in the sheet.
Comments	String		Additional notes or comments provided for the task or event.
Status	String		The current status of the task or event, such as 'In Progress,' 'Completed,' or 'Not Started.'
Due	Datetime		The due date and time for the task or event, formatted as a datetime object.
Due Date	Datetime		The specific due date for the task or event without the time component.
Budget	String		The budget associated with the task or event, often used for financial tracking.
Assigned	String		The person or entity to whom the task or event is currently assigned.
Actual	String		The actual cost, time, or resource allocation for the task or event.
Notes & Comments	String		Detailed notes and comments related to the task or event, providing additional context.
Reviewed	Boolean		A boolean flag indicating whether the task or event has been reviewed (true or false).
Progress	String		A textual or percentage-based indication of the task's progress, such as '50%' or 'Halfway Complete.'

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Smartsheet.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Smartsheet, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Smartsheet Stored Procedures

Name	Description
CopyRowsToAnotherSheet	Copy rows from one Smartsheet to another, streamlining data reorganization.
CopySheet	Duplicate an existing sheet and relocate it to a specified folder, home directory, or workspace.
CreateSheet	Create a new sheet in Smartsheet for data organization and tracking.
DeleteAttachment	Delete an attachment located in one of your Smartsheet sheets.
DeleteDashboardShare	Delete a dashboard share in your Smartsheet account.
DeleteReportShare	Delete a report share in your Smartsheet account.
DeleteSheet	Delete a specific sheet from Smartsheet to manage space and relevance.
DeleteSheetShare	Delete a sheet share in your Smartsheet account.
DeleteUser	Delete a user in your Smartsheet account.
DeleteWorkspaceShare	Delete a workspace share in your Smartsheet account.
ImportFile	Import CSV or XLSX files into Smartsheet, specifying the target folder or workspace.
MoveRowsToAnotherSheet	Move rows between Smartsheets for efficient data organization and management.
MoveSheet	Relocate a sheet to a new folder, home directory, or workspace for better accessibility.
ShareDashboard	Share a dashboard with a user or group in your Smartsheet account.
ShareReport	Share a report with a user or group in your Smartsheet account.
ShareSheet	Share a sheet with a user or group in your Smartsheet account.
ShareWorkspace	Share a workspace with a user or group in your Smartsheet account.
UpdateDashboardShare	Update a dashboard share in your Smartsheet account.
UpdateReportShare	Update a report share in your Smartsheet account.
UpdateSheetShare	Update a sheet share in your Smartsheet account.
UpdateWorkspaceShare	Update a workspace share in your Smartsheet account.

Copy rows from one Smartsheet to another, streamlining data reorganization.

Input

Name	Type	Required	Description
SheetId	String	False	The unique identifier of the source sheet from which rows will be copied.
RowIds	String	False	A comma-separated list of row IDs to copy from the source sheet. Required unless 'RowIdsFilePath' is provided.
RowIdsFilePath	String	False	The full file path to a local text file containing a comma-separated list of row IDs to be copied. Use this if 'RowIds' is not directly specified.
DestinationSheetId	String	False	The unique identifier of the destination sheet where rows will be copied.
Include	String	False	Optional. Specifies additional row elements to copy beyond cell data. Can include 'attachments', 'discussions', 'children', or 'all' to copy all elements.
IgnoreRowsNotFound	String	False	Optional parameter. Specifies whether to ignore missing row IDs in the source sheet. The option 'true' skips errors for missing IDs, while 'false' (the default) causes the operation to fail if any row IDs are not found.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the operation to copy rows completed successfully (true or false).
AffectedRows	String	The total number of rows successfully copied to the destination sheet.

Duplicate an existing sheet and relocate it to a specified folder, home directory, or workspace.

Input

Name	Type	Required	Description
SheetId	String	False	The unique identifier of the source sheet to be copied. This is a required parameter for initiating the copy operation.
DestinationType	String	False	Specifies the type of container where the sheet will be copied. Accepted values are 'folder' (for folders), 'home' (for personal space), or 'workspace' (for shared workspaces).
DestinationId	String	False	The unique identifier of the destination container. This is required if 'DestinationType' is 'folder' or 'workspace' but must be null when 'DestinationType' is 'home'.
NewName	String	False	The desired name for the newly created copy of the sheet. This attribute is applicable for copy operations only and is ignored for move operations.
Include	String	False	A comma-separated list of additional sheet elements to include in the copy operation. Options include 'attachments' (file attachments), 'cellLinks' (cross-sheet references), 'data' (includes cell data and formatting), 'discussions' (comments), 'filters', 'forms', 'ruleRecipients' (notification recipients must include 'rules'), 'rules' (workflow rules), 'shares' (shared user access). Note that the Cell history cannot be copied.
Exclude	String	False	Optional parameter. Use 'sheetHyperlinks' to exclude hyperlinks in the copied sheet.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the sheet copy operation completed successfully. Returns 'true' for success and 'false' for failure.

Create a new sheet in Smartsheet for data organization and tracking.

Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the table below, indexed parameters are denoted with a '#' character at the end of their names.

Input

Name	Type	Required	Description
SheetName	String	True	The name of the new sheet to be created. This should be a unique, user-friendly identifier for the sheet.
ColumnName#	String	False	The name of the column to be added to the sheet. Use descriptive names for clarity.
ColumnType#	String	False	The data type of the column values, such as Text, Number, or Date, which defines how the column data will be stored and validated.
PrimaryColumn#	String	False	Indicates whether the specified column is the primary column, which typically serves as the main identifier for rows in the sheet.

Result Set Columns

Name	Type	Description
Success	String	A boolean or status flag indicating if the sheet creation operation was successful.
Id	String	The unique identifier of the sheet created.

Delete an attachment located in one of your Smartsheet sheets.

Procedure-specific Information

Executing this procedure can have different effects, based on the values specified in the procedure parameters:

• If the value specified in the AttachmentId parameter corresponds to the identifier of a specific version of the attachment, then only that version is deleted.
• If the value specified in the AttachmentId parameter corresponds to the identifier of the attachment and that attachment has only 1 version, then the attachment is deleted completely.
• If the value specified in the AttachmentId parameter corresponds to the identifier of the attachment and the DeleteAllVersions parameter is set to true, then the attachment is deleted completely.

Input

Name	Type	Required	Description
SheetId	String	True	The unique identifier of the sheet containing the attachment to be deleted.
AttachmentId	String	True	The unique identifier of the attachment or attachment version to be deleted.
DeleteAllVersions	Boolean	False	Boolean value indicating whether to delete all versions of the attachment, which would delete the attachment itself completely as well.

Result Set Columns

Name	Type	Description
Success	Boolean	Boolean value indicating whether the deletion operation was successful. Returns 'true' if the attachment (or version) was deleted, and 'false' otherwise.

Delete a dashboard share in your Smartsheet account.

Input

Name	Type	Required	Description
DashboardId	String	True	The unique identifier of the dashboard which was shared.
ShareId	String	True	The unique identifier of the dashboard share.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean value indicating whether the operation was successful. Returns 'true' if the dashboard share was deleted successfully, and 'false' otherwise.

Delete a report share in your Smartsheet account.

Input

Name	Type	Required	Description
ReportId	String	True	The unique identifier of the report which was shared.
ShareId	String	True	The unique identifier of the report share.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean value indicating whether the operation was successful. Returns 'true' if the report share was deleted successfully, and 'false' otherwise.

Delete a specific sheet from Smartsheet to manage space and relevance.

Input

Name	Type	Required	Description
SheetId	String	False	The unique identifier of the sheet to be deleted. This is typically a numeric or GUID value that uniquely identifies a sheet in Smartsheet.
SheetName	String	False	The name of the sheet to be deleted. This should match the name of an existing sheet, providing a human-readable reference.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the deletion operation was successful. Returns 'true' for success or 'false' if the operation failed.

Delete a sheet share in your Smartsheet account.

Input

Name	Type	Required	Description
SheetId	String	True	The unique identifier of the sheet which was shared.
ShareId	String	True	The unique identifier of the sheet share.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean value indicating whether the operation was successful. Returns 'true' if the sheet share was deleted successfully, and 'false' otherwise.

Delete a user in your Smartsheet account.

Input

Name	Type	Required	Description
UserId	String	True	The unique identifier of the user to be deleted.
RemoveFromSharing	Boolean	False	Boolean value indicating whether to remove the user's access to all assets created by them in your account.
TransferOwnership	Boolean	False	Boolean value indicating whether to transfer ownership of all the deleted user's assets to another user. By default, the ownership is transferred to the group owner of each group the deleted user was part of.
TransferTo	String	False	The unique identifier of the user to which the assets of the deleted user will be transferred to. Applies only when 'TransferOwnership' is set to true. Use this parameter to override the default behavior of 'TransferOwnership'.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean value indicating whether the operation was successful. Returns 'true' if the user was deleted, and 'false' otherwise.

Delete a workspace share in your Smartsheet account.

Input

Name	Type	Required	Description
WorkspaceId	String	True	The unique identifier of the workspace which was shared.
ShareId	String	True	The unique identifier of the workspace share.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean value indicating whether the operation was successful. Returns 'true' if the workspace share was deleted successfully, and 'false' otherwise.

Import CSV or XLSX files into Smartsheet, specifying the target folder or workspace.

Input

Name	Type	Required	Description
SheetName	String	True	Required. Specifies the name of the new sheet to be created in Smartsheet. This will appear as the title of the sheet.
HeaderRowIndex	String	False	Optional parameter. A zero-based integer that identifies the row to use as column headers in the imported file. Rows before this index are ignored during the import. If omitted, columns are assigned default names such as Column1, Column2, etc.
PrimaryColumnIndex	String	False	Optional parameter. A zero-based integer indicating which column to set as the primary column in the new sheet. The primary column is used for unique identifiers and critical data. Defaults to 0 if not specified.
FileName	String	True	Specifies the name and extension of the file to upload, including the optional full file path if the Content parameter is not used. For example: 'C:/Users/Public/Desktop/Departments.csv'.
FolderId	String	False	Specifies the folder where the new sheet will be created. If provided, the imported data is saved into a new sheet within this folder.
WorkspaceId	String	False	Specifies the workspace where the new sheet will be created. If provided, the imported data is saved into a new sheet within this workspace.
Overwrite	String	False	Indicates whether to overwrite an existing sheet with the same name. If true, FolderId or WorkspaceId is required and the existing sheet will be replaced with the new data. The default value is false.

Result Set Columns

Name	Type	Description
Id	String	The unique identifier of the newly created or updated sheet.
Name	String	The name of the newly created or updated sheet as it appears in Smartsheet.
AccessLevel	String	The access level of the current user on the new sheet, such as 'Viewer', 'Editor', or 'Admin'.
Permalink	String	The direct URL link to access the newly created or updated sheet in Smartsheet.
Success	String	Indicates whether the deletion operation was successful. Returns 'true' for success or 'false' if the operation failed.

Move rows between Smartsheets for efficient data organization and management.

Input

Name	Type	Required	Description
SheetId	String	False	The unique identifier of the source sheet from which rows will be moved.
RowIds	String	False	A list of row IDs to move, provided as comma-separated values. This is required unless RowIdsFilePath is specified.
RowIdsFilePath	String	False	The absolute path to a local text file containing a comma-separated list of row IDs to be moved. This is required unless RowIds is specified.
DestinationSheetId	String	False	The unique identifier of the destination sheet where rows will be moved to.
Include	String	False	An optional, comma-separated list specifying additional elements to move along with the rows, such as attachments or discussions.
IgnoreRowsNotFound	String	False	Optional parameter. Set to 'True' to ignore errors for rows not found in the source sheet. The default is 'False', causing an error if non-existent rows are specified.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the rows were moved successfully (True or False).
AffectedRows	String	The total number of rows that were successfully moved.

Relocate a sheet to a new folder, home directory, or workspace for better accessibility.

Input

Name	Type	Required	Description
SheetId	String	True	The unique identifier of the sheet to be relocated within Smartsheet.
DestinationType	String	True	Specifies the target container type for the sheet relocation. Valid values include 'folder', 'home', or 'workspace'.
DestinationId	String	False	The unique identifier of the target container for the sheet relocation. Mandatory if 'DestinationType' is 'folder' or 'workspace'. If 'DestinationType' is 'home', this value must be null.

Result Set Columns

Name	Type	Description
Success	String	Indicates if the sheet was successfully moved to the specified destination (True or False).

Share a dashboard with a user or group in your Smartsheet account.

Input

Name	Type	Required	Description
DashboardId	String	True	The unique identifier of the dashboard being shared.
UserEmail	String	False	The email of the user to share the dashboard with.
GroupId	String	False	The unique identifier of the group to share the dashboard with.
AccessLevel	String	True	The access level for the user or group on the shared dashboard. The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.
SendEmail	Boolean	False	Boolean value indicating whether to notify the user or group about the shared dashboard with an email.
CcMe	Boolean	False	Boolean value indicating whether to send a copy of the email to the sharer of the dashboard. Applies only when 'SendEmail' is set to true.
EmailSubject	String	False	The subject of the email for the shared dashboard. Applies only when 'SendEmail' is set to true.
EmailMessage	String	False	The message of the email for the shared dashboard. Applies only when 'SendEmail' is set to true.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean value indicating whether the operation was successful. Returns 'true' if the dashboard was shared successfully, and 'false' otherwise.
Id	String	The unique identifier of the created dashboard share.

Share a report with a user or group in your Smartsheet account.

Input

Name	Type	Required	Description
ReportId	String	True	The unique identifier of the report being shared.
UserEmail	String	False	The email of the user to share the report with.
GroupId	String	False	The unique identifier of the group to share the report with.
AccessLevel	String	True	The access level for the user or group on the shared report. The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.
SendEmail	Boolean	False	Boolean value indicating whether to notify the user or group about the shared report with an email.
CcMe	Boolean	False	Boolean value indicating whether to send a copy of the email to the sharer of the report. Applies only when 'SendEmail' is set to true.
EmailSubject	String	False	The subject of the email for the shared report. Applies only when 'SendEmail' is set to true.
EmailMessage	String	False	The message of the email for the shared report. Applies only when 'SendEmail' is set to true.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean value indicating whether the operation was successful. Returns 'true' if the report was shared successfully, and 'false' otherwise.
Id	String	The unique identifier of the created report share.

Share a sheet with a user or group in your Smartsheet account.

Input

Name	Type	Required	Description
SheetId	String	True	The unique identifier of the sheet being shared.
UserEmail	String	False	The email of the user to share the sheet with.
GroupId	String	False	The unique identifier of the group to share the sheet with.
AccessLevel	String	True	The access level for the user or group on the shared sheet. The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.
SendEmail	Boolean	False	Boolean value indicating whether to notify the user or group about the shared sheet with an email.
CcMe	Boolean	False	Boolean value indicating whether to send a copy of the email to the sharer of the sheet. Applies only when 'SendEmail' is set to true.
EmailSubject	String	False	The subject of the email for the shared sheet. Applies only when 'SendEmail' is set to true.
EmailMessage	String	False	The message of the email for the shared sheet. Applies only when 'SendEmail' is set to true.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean value indicating whether the operation was successful. Returns 'true' if the sheet was shared successfully, and 'false' otherwise.
Id	String	The unique identifier of the created sheet share.

Share a workspace with a user or group in your Smartsheet account.

Input

Name	Type	Required	Description
WorkspaceId	String	True	The unique identifier of the workspace being shared.
UserEmail	String	False	The email of the user to share the workspace with.
GroupId	String	False	The unique identifier of the group to share the workspace with.
AccessLevel	String	True	The access level for the user or group on the shared workspace. The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.
SendEmail	Boolean	False	Boolean value indicating whether to notify the user or group about the shared workspace with an email.
CcMe	Boolean	False	Boolean value indicating whether to send a copy of the email to the sharer of the workspace. Applies only when 'SendEmail' is set to true.
EmailSubject	String	False	The subject of the email for the shared workspace. Applies only when 'SendEmail' is set to true.
EmailMessage	String	False	The message of the email for the shared workspace. Applies only when 'SendEmail' is set to true.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean value indicating whether the operation was successful. Returns 'true' if the workspace was shared successfully, and 'false' otherwise.
Id	String	The unique identifier of the created workspace share.

Update a dashboard share in your Smartsheet account.

Input

Name	Type	Required	Description
DashboardId	String	True	The unique identifier of the dashboard which was shared.
ShareId	String	True	The unique identifier of the dashboard share.
AccessLevel	String	True	The access level for the user or group on the shared dashboard. The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean value indicating whether the operation was successful. Returns 'true' if the dashboard share was updated successfully, and 'false' otherwise.

Update a report share in your Smartsheet account.

Input

Name	Type	Required	Description
ReportId	String	True	The unique identifier of the report which was shared.
ShareId	String	True	The unique identifier of the report share.
AccessLevel	String	True	The access level for the user or group on the shared report. The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean value indicating whether the operation was successful. Returns 'true' if the report share was updated successfully, and 'false' otherwise.

Update a sheet share in your Smartsheet account.

Input

Name	Type	Required	Description
SheetId	String	True	The unique identifier of the sheet which was shared.
ShareId	String	True	The unique identifier of the sheet share.
AccessLevel	String	True	The access level for the user or group on the shared sheet. The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean value indicating whether the operation was successful. Returns 'true' if the sheet share was updated successfully, and 'false' otherwise.

Update a workspace share in your Smartsheet account.

Input

Name	Type	Required	Description
WorkspaceId	String	True	The unique identifier of the workspace which was shared.
ShareId	String	True	The unique identifier of the workspace share.
AccessLevel	String	True	The access level for the user or group on the shared workspace. The allowed values are ADMIN, COMMENTER, EDITOR, EDITOR_SHARE, OWNER, VIEWER.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean value indicating whether the operation was successful. Returns 'true' if the workspace share was updated successfully, and 'false' otherwise.

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Smartsheet:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries, including batch operations::

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Sheet_Test_Sheet table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Sheet_Test_Sheet' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the RefreshOAuthAccessToken stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'RefreshOAuthAccessToken' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'RefreshOAuthAccessToken' AND IncludeResultColumns='True'

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native Smartsheet procedure.

Pseudo-Columns

Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

Describes the primary and foreign keys.

The following query retrieves the primary key for the Sheet_Test_Sheet table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Sheet_Test_Sheet' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.