Smartsheet Connector Objects

NameDescription
InfoAttachmentsRetrieve detailed information about Smartsheet attachments, which can be associated with comments, rows, or sheets, providing a comprehensive view of file dependencies.
InfoCellHistoryAccess the historical changes of specific cells in Smartsheet, enabling detailed audit and tracking capabilities.
InfoCellsExplore individual cell data in Smartsheet rows, offering granular insights into sheet contents.
InfoColumnsRetrieve metadata and properties of columns in Smartsheet sheets or reports, essential for understanding sheet structures.
InfoCommentsAccess comments within discussions in Smartsheet, providing insights into collaboration history.
InfoContactsQuery Smartsheet user contact details, facilitating management of personal and shared connections.
InfoDiscussionsAnalyze discussion threads, including comments, tied to specific rows or sheets for better communication tracking.
InfoFavoritesRetrieve a user's favorite items in Smartsheet, helping prioritize frequently accessed content.
InfoFoldersExplore folder structures in Smartsheet, including user-level folders and workspace organization.
InfoGroupsRetrieve group information for enhanced user management and role-based permissions in Smartsheet.
InfoHomeAccess items available on the Smartsheet Home tab, offering a centralized view of user-permissible objects.
InfoReportsQuery Smartsheet reports, providing insights into custom aggregated data across sheets.
InfoReportSharesQuery the Sharing operations of Reports.
InfoRowsRetrieve detailed row data, including cells, discussions, and attachments, for enhanced row-level analysis.
InfoServerInformationAccess Smartsheet server information and application constants, useful for API integrations.
InfoSharesRetrieve sharing configurations for Smartsheet reports, sheets, and workspaces to manage access controls.
InfoSheetsExplore detailed metadata and structure of Smartsheet sheets, including their components like columns, rows, and attachments.
InfoSheetSharesQuery the Sharing operations of Sheets.
InfoTemplatesRetrieve Smartsheet template information to streamline the creation of standardized sheets.
InfoUsersQuery user data within an organization for administrative and reporting purposes.
InfoWorkspacesAccess workspace-level details, including sheets and folders, for better organizational insights.
InfoWorkspaceSharesQuery the Sharing operations of Workspaces.
ReportSalesActivityAndTeamObjectivesAnalyze sales activities and team objectives using a dedicated Smartsheet report for performance tracking.
ReportTasksandEventsAccess detailed task and event data within a Smartsheet report for efficient planning and monitoring.
SheetContentCalendarManage and analyze the Sheet_Content_Calendar, designed for scheduling and content tracking.
SheetCustomerOrderTrackingHistoryTrack and analyze historical customer order data using the Sheet_Customer_Order_Tracking_History.
SheetEventPlanBudgetPlan, budget, and track event-related data with the Sheet_Event_Plan_Budget table.
SheetExpenseReportManage and analyze expense reports effectively using the Sheet_Expense_Report table.
SheetGanttProjectwithHardDeadlineTrack and manage projects with fixed deadlines using a Gantt-style layout in this Smartsheet table.
SheetJobCandidateTrackerTrack and manage job candidate progress and information with the Sheet_Job_Candidate_Tracker table.
SheetSalesActivityTrackingbyRepMonthMonitor sales activity by representative and month with the Sheet_Sales_Activity_Tracking_by_Rep_Month table.
SheetSimpleSalesPipelineSimplify sales tracking using the Sheet_Simple_Sales_Pipeline table for streamlined data management.
SheetTeamObjectivesTrackerMonitor and track team objectives efficiently using the Sheet_Team_Objectives_Tracker.
SheetTeamTaskListbyPriorityPrioritize and manage team tasks with the Sheet_Team_Task_List_by_Priority table.
SheetWebFormTestTest and analyze web form data integration using the Sheet_WebFormTest table.
NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoA unique identifier assigned to each attachment for tracking and retrieval purposes.
NameStringFalseNoThe user-assigned or system-generated name of the attachment, helping identify its content or purpose.
UrlStringFalseNoA temporary URL that allows access to the attachment file for download or viewing.
UrlExpiresInMillisLongFalseNoThe lifespan, in milliseconds, of the temporary URL before it expires and becomes inaccessible.
AttachmentTypeStringFalseNoThe category of the attachment, such as FILE or external integrations like GOOGLE_DRIVE, BOX_COM, or DROPBOX.
AttachmentSubTypeStringFalseNoSpecifies the subtype for GOOGLE_DRIVE (for example, DOCUMENT, SPREADSHEET) or EGNYTE attachments (for example, FOLDER), providing further detail on the content format.
CreatedAtTimestampFalseNoThe timestamp indicating when the attachment was first added to the system.
UserIdStringFalseNoThe unique identifier of the user who uploaded or created the attachment.
UserEmailStringFalseNoThe email address of the user who added the attachment, used for contact or audit purposes.
UserNameStringFalseNoThe full name of the user who uploaded the attachment, displayed for reference. This is read-only.
MimeTypeStringFalseNoThe file type of the attachment, expressed as a multipurpose internet mail extension (MIME) type (for example, image/png or application/pdf).
ParentTypeStringFalseNoIndicates the type of Smartsheet object the attachment is associated with, such as SHEET, ROW, or COMMENT.
ParentIdStringFalseNoThe unique identifier of the parent object (for example, sheet or row) that the attachment belongs to.
SizeInKbLongFalseNoThe size of the attachment file in kilobytes, applicable only for attachments of type FILE.
SheetIdStringFalseNoThe unique identifier of the sheet to which the attachment is linked.
RowIdStringFalseNoThe unique identifier of the row within a sheet where the attachment is associated.
DiscussionIdStringFalseNoThe unique identifier of the discussion thread to which the attachment is linked.
CommentIdStringFalseNoThe unique identifier of the comment in which the attachment is embedded.
FilePathStringFalseNoThe file path on the local system used to insert the attachment into Smartsheet.
ContentEncodedStringFalseNoThe BASE64-encoded representation of the file's content, used when uploading files.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ValueStringFalseNoThe 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.
ModifiedAtDatetimeFalseNoThe date and time when the cell was last updated. This helps in identifying the most recent activity in the cell.
EditorNameStringFalseNoThe full name of the user who made the latest changes to the cell. This provides clarity about who is responsible for updates.
EditorEmailStringFalseNoThe email address of the user who last modified the cell, allowing for easy communication or audit purposes.
SheetIdStringFalseNoA unique identifier for the sheet containing this cell. This links the cell to its corresponding sheet in Smartsheet.
RowIdStringFalseNoA unique identifier for the row in which this cell is located. This helps in pinpointing and managing specific rows.
ColumnIdStringFalseNoA unique identifier for this cell's column enables efficient column-based operations or analysis.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe unique identifier of the column that contains the cell. This is a reference to the parent column in the sheet's schema.
ValueStringFalseNoThe actual content of the cell, which can be a string, number, or boolean, representing the cell's primary data.
DisplayValueStringFalseNoThe formatted version of the cell's content as displayed to the user in the Smartsheet UI, reflecting applied formats and rules.
ColumnTypeStringFalseNoThe type of data or content allowed in the column (for example, text, date, dropdown) as defined in the column's schema.
FormulaStringFalseNoThe formula applied to the cell, if any, used to compute dynamic values based on other cell references.
FormatStringFalseNoDescriptor specifying the visual formatting of the cell, such as text style, color, or alignment.
ConditionalFormatStringFalseNoThe formatting applied to the cell based on conditional rules set at the column or sheet level.
StrictBooleanFalseNoIndicates if strict parsing rules are applied to the cell's value. Defaults to true; set to false for more lenient value handling.
SheetIdStringFalseNoThe unique identifier of the sheet to which this cell belongs.
RowIdStringFalseNoThe unique identifier of the row containing this cell, representing its position in the sheet.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique identifier for the column, used to reference it programmatically.
IndexIntegerFalseNoThe numeric position of the column in the sheet, starting at 0 for the first column.
TitleStringFalseNoThe displayed name of the column, as shown in the Smartsheet interface.
PrimaryBooleanTrueNoIndicates whether this column is the primary column, which typically contains key identifiers or names for rows.
TypeStringFalseNoThe functional data type of the column, determining how data is stored and validated.
OptionsAggregateStringFalseNoA list of selectable options for the column, applicable for columns like dropdowns or picklists.
ContactOptionsStringFalseNoArray of the contact options available for the column.
HiddenBooleanFalseNoIndicates whether the column is hidden in the Smartsheet interface.
SymbolStringFalseNoRepresents visual markers or indicators used in the column, with values varying by column type (for example, checkboxes, picklists).
ColumnTypeStringFalseNoThe system-defined column type.
TagsAggregateStringTrueNoDefines system tags for the column, used to indicate roles in features like Gantt charts or calendars (for example, 'gantt_duration').
WidthIntegerFalseNoThe pixel width used to display the column in the sheet's user interface.
FormatStringFalseNoThe applied formatting settings for the column, such as text alignment or date format.
FilterTypeStringTrueNoSpecifies the type of filter applied to the column, with options such as 'list' for predefined values or 'custom' for user-defined filters.
LockedBooleanFalseNoIndicates whether the column is locked, preventing edits by all users except the owner or admin.
LockedForUserBooleanFalseNoIndicates whether the column is locked for the current user based on their permissions.
SheetIdStringTrueNoThe unique identifier of the sheet to which this column belongs.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoA unique identifier assigned to each comment, ensuring it can be referenced distinctly.
TextStringFalseNoThe main content of the comment, containing the user's input or feedback.
UserNameStringFalseNoThe name of the user who authored the comment, useful for identifying contributors.
UserEmailStringFalseNoThe email address of the user who authored the comment, allowing for communication or verification.
CreatedAtDatetimeFalseNoThe timestamp indicating when the comment was originally created.
ModifiedAtDatetimeFalseNoThe timestamp indicating the most recent update or edit made to the comment.
AttachmentsAggregateStringFalseNoA serialized array of attachment objects associated with the comment, providing access to related files.
DiscussionIdStringFalseNoThe unique identifier of the discussion thread to which the comment belongs.
SheetIdStringFalseNoThe unique identifier of the sheet where the comment is located.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoA unique identifier assigned to each contact, used to differentiate them within the database.
NameStringFalseNoThe full name of the contact, typically including both first and last names.
EmailStringFalseNoThe primary email address associated with the contact, used for communication purposes.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoA unique identifier for the discussion within the Smartsheet.
TitleStringFalseNoThe subject or headline of the discussion, providing a brief summary of its content.
AccessLevelStringFalseNoIndicates the user's permission level for accessing the discussion (for example, view, edit).
ParentIdStringFalseNoThe unique identifier of the row or sheet directly associated with the discussion.
ParentTypeStringFalseNoSpecifies whether the discussion is linked to a row or a sheet. Possible values include: SHEET or ROW.
LastCommentedAtDatetimeFalseNoThe timestamp indicating when the most recent comment was added to the discussion.
LastCommentByStringFalseNoThe full name of the user who made the latest comment in the discussion.
CreatorNameStringFalseNoThe full name of the user who initiated the discussion.
ReadOnlyBooleanFalseNoIndicates if the discussion is in a read-only state, preventing any modifications.
SheetIdStringFalseNoThe unique identifier of the sheet where the discussion is located.
RowIdStringFalseNoThe unique identifier of the row associated with the discussion.
FirstDiscussionCommentStringFalseYesA special input-only field for adding the initial comment to a new discussion.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ObjectIdStringFalseNoA 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.
TypeStringFalseNoSpecifies 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.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoA system-generated unique identifier for the folder, used to reference it programmatically.
NameStringFalseNoThe user-defined name of the folder, typically representing its content or purpose.
PermalinkStringFalseNoA direct, shareable URL linking to the folder within Smartsheet, useful for quick access.
FavoriteBooleanFalseNoIndicates whether the user has marked the folder as a favorite for easier navigation in their Home tab.
WorkspaceIdStringFalseNoThe unique identifier of the workspace that contains this folder, useful for context within a workspace hierarchy.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoA unique identifier for the group, used as the primary key.
NameStringFalseNoThe descriptive name of the group, typically used for display and identification.
DescriptionStringFalseNoA brief summary or details about the purpose or function of the group.
OwnerStringFalseNoThe email address of the user who owns or administers the group.
OwnerIdStringFalseNoThe unique identifier for the user who owns or manages the group.
CreatedAtDatetimeFalseNoThe timestamp indicating when the group was initially created.
ModifiedAtDatetimeFalseNoThe timestamp indicating the most recent update or change made to the group.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
SheetsAggregateStringFalseNoAn array containing details about all sheet objects associated with the home information.
FoldersAggregatStringFalseNoAn array containing details about all folder objects within the current context of the home environment.
ReportsAggregatStringFalseNoAn array containing details about all report objects, providing insights into shared or owned reports in the home scope.
TemplatesAggregatStringFalseNoAn array containing details about all template objects available within the home context, used for creating new sheets.
WorkspacesAggregatStringFalseNoAn array containing details about all workspace objects, representing collaborative spaces within the home environment.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoA unique identifier for the report, used as the primary key for reference.
NameStringFalseNoThe descriptive name of the report, typically used to identify its purpose or content.
FolderIdStringFalseNoThe unique identifier of the folder where the report is stored, indicating its organizational structure.
WorkspaceIdStringFalseNoThe unique identifier of the workspace containing this report, representing its broader context and ownership.
PermalinkStringFalseNoURL that represents a direct link to the report in Smartsheet.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe unique identifier of this share.
ReportId [KEY]StringFalseNoThe Id of the report.
TypeStringFalseNoThe type of this share. Possible values: USER or GROUP.
UserIdStringFalseNoThe user Id for a user share.
GroupIdStringFalseNoThe group Id of a group share.
EmailStringFalseNoThe email address for a user share.
NameStringFalseNoThe full name for a user share where the user is also a contact. The group name for a group share.
AccessLevelStringFalseNoThe access level for the user or group on the shared object.
ScopeStringFalseNoThe scope of the share (ITEM or WORKSPACE).
CreatedAtDatetimeFalseNoTime that the share was created.
ModifiedAtDatetimeFalseNoTime that the share was modified.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoA unique identifier for the row, assigned by Smartsheet. This value is guaranteed to be unique within the sheet.
RowNumberIntegerFalseNoThe sequential number of the row within the sheet, starting at 1. Useful for referencing rows in a user-friendly way.
VersionIntegerFalseNoIndicates the current version of the sheet. This number increments each time a modification is made to the sheet.
FilteredOutBooleanFalseNoIndicates if this row is excluded from view by an applied column filter. True means the row is hidden; False means it is visible.
InCriticalPathBooleanFalseNoTrue if this row is part of the critical path in a project sheet with dependencies enabled. Useful for project planning and scheduling.
LockedBooleanFalseNoIndicates if the row has been locked by the sheet owner or admin to prevent changes.
LockedForUserBooleanFalseNoIndicates if the row is locked for the current user based on their permissions.
ExpandedBooleanFalseNoShows whether the row is currently expanded to reveal child rows or collapsed to hide them.
AccessLevelStringFalseNoDefines the user's access permissions to the sheet containing this row (for example, Viewer, Editor, Admin).
FormatStringFalseNoDescribes the visual format applied to the row, such as font color, background color, and text styles.
ConditionalFormatStringFalseNoSpecifies the visual format applied to the row due to a conditional formatting rule.
CreatedAtDatetimeFalseNoThe timestamp when the row was initially created in Smartsheet.
ModifiedAtDatetimeFalseNoThe timestamp when the row was last modified. Helps track changes over time.
PermalinkStringFalseNoA permanent URL linking directly to this row in Smartsheet for easy access.
ParentIdStringFalseNoThe unique identifier of the parent row, if this row is part of a hierarchical structure.
SiblingIdStringFalseNoThe unique identifier of the previous sibling row at the same hierarchical level. Useful for determining row order.
ToTopBooleanFalseNoA flag indicating if the row should be moved or inserted at the top of the sheet.
ToBottomBooleanFalseNoA flag indicating if the row should be moved or inserted at the bottom of the sheet.
AboveBooleanFalseNoA flag indicating if the row should be moved or inserted above another specified row.
SheetIdStringFalseNoThe unique identifier of the sheet to which this row belongs.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
SupportedLocalesStringFalseNoAn array of locale strings supported by Smartsheet, used for regional and language settings.
FormatsDefaultsStringFalseNoDescribes default format settings for display in the Smartsheet Web application when no custom format values are applied.
FontFamilyStringFalseNoDefines the font families available, including additional metadata about each font.
FontSizeStringFalseNoSpecifies font sizes in points, representing the height of characters in text.
BoldStringFalseNoIndicates if text is bolded. Possible values include 'none' (not bolded) and 'on' (bolded).
ItalicStringFalseNoIndicates if text is italicized. Possible values include 'none' (not italicized) and 'on' (italicized).
UnderlineStringFalseNoIndicates if text is underlined. Possible values include 'none' (no underline) and 'on' (underlined).
StrikethroughStringFalseNoIndicates if text has a strikethrough effect. Possible values include 'none' (no strikethrough) and 'on' (strikethrough applied).
HorizontalAlignStringFalseNoDefines horizontal text alignment within cells. Possible values include 'none', 'left', 'center', 'right'.
VerticalAlignStringFalseNoDefines vertical text alignment within cells. Possible values include 'top', 'middle', 'bottom'. The default value is 'top'.
ColorStringFalseNoSpecifies text and background color in hex format. If 'none', applications use default colors (for example, Black for text, White for background).
CurrencyStringFalseNoLists supported currency codes (for example, USD, EUR) along with their respective symbols.
ThousandsSeparatorStringFalseNoDetermines if numbers display a thousands separator (for example, 1,000). Possible values include 'none' (no separator) and 'on' (separator applied).
NumberFormatStringFalseNoSpecifies how numbers are formatted. Possible values include 'none', 'NUMBER', 'CURRENCY', 'PERCENT'.
TextWrapStringFalseNoIndicates whether text wraps within the cell. Possible values include 'none' (no wrap) and 'on' (text wraps).

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoA unique identifier assigned to this share, used to differentiate it from other shares.
TypeStringFalseNoSpecifies whether the share is for an individual user (USER) or a group (GROUP).
UserIdStringFalseNoThe unique identifier of the user associated with this share when the share type is USER.
GroupIdStringFalseNoThe unique identifier of the group associated with this share when the share type is GROUP.
EmailStringFalseNoThe email address of the user receiving the share, used for sending notifications and identifying the user.
NameStringFalseNoThe full name of the user or the name of the group associated with the share. For users, this is shown if they are also a contact.
AccessLevelStringFalseNoDefines the level of access granted to the user or group, such as Viewer, Editor, or Admin, on the shared object.
SubjectStringFalseNoThe subject line of the optional email notification sent to inform the recipient about the share.
MessageStringFalseNoThe body text of the optional email notification sent to provide details or context about the share.
CcMeBooleanFalseNoIndicates whether the sharer should receive a copy of the notification email sent to the recipient. True if enabled.
WorkspaceIdStringFalseNoThe unique identifier of the workspace that is shared.
SheetIdStringFalseNoThe unique identifier of the sheet that is shared within the workspace.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoA unique identifier assigned to the sheet, used for referencing it programmatically or in APIs.
NameStringFalseNoThe descriptive name of the sheet, visible to users in the Smartsheet interface.
OwnerStringFalseNoThe email address of the user who owns the sheet and has primary control over its permissions and content.
OwnerIdStringFalseNoThe unique identifier of the user who owns the sheet, used for internal user management.
PermalinkStringFalseNoA permanent, shareable URL that provides direct access to the sheet in Smartsheet.
SourceIdStringFalseNoThe unique identifier of the original sheet or template from which this sheet was created, useful for tracing its origin.
SourceTypeStringFalseNoIndicates whether the source object for this sheet was a 'sheet' or a 'template', helping to categorize its origin.
CreatedAtDatetimeFalseNoThe timestamp indicating when the sheet was first created in Smartsheet.
ModifiedAtDatetimeFalseNoThe timestamp of the most recent modification made to the sheet's content or properties.
VersionLongFalseNoA revision number incremented with each change made to the sheet, useful for tracking updates.
TotalRowCountLongFalseNoThe total number of rows currently present in the sheet, reflecting its data capacity or usage.
AccessLevelStringFalseNoThe permission level of the current user for this sheet, such as 'viewer', 'editor', or 'admin'.
ReadOnlyBooleanFalseNoIndicates if the sheet is in read-only mode, typically due to an expired trial or restricted permissions.
GanttEnabledBooleanFalseNoSpecifies whether the Gantt chart feature is enabled for this sheet, allowing project timelines to be visualized.
DependenciesEnabledBooleanFalseNoShows if dependency tracking is active, used for managing task relationships and schedules.
ResourceManagementEnabledBooleanFalseNoIndicates if resource management tools are enabled, supporting workload and capacity planning.
FavoriteBooleanFalseNoIndicates whether the user has marked this sheet as a favorite, making it easier to locate in their Home tab.
ShowParentRowsForFiltersBooleanFalseNoSpecifies if the 'Show Parent Rows' option is enabled for filtering, helping to display hierarchical context.
FromIdStringFalseNoThe unique identifier of the template from which the sheet was originally created, used for template-based organization.
WorkspaceIdStringFalseNoThe unique identifier of the workspace where the sheet is stored, aiding in categorization and collaboration.
FolderIdStringFalseNoThe unique identifier of the folder containing the sheet, for better organization within Smartsheet.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe unique identifier of this share.
SheetId [KEY]StringFalseNoThe Id of the sheet.
TypeStringFalseNoThe type of this share. Possible values: USER or GROUP.
UserIdStringFalseNoThe user Id for a user share.
GroupIdStringFalseNoThe group Id of a group share.
EmailStringFalseNoThe email address for a user share.
NameStringFalseNoThe full name for a user share where the user is also a contact. The group name for a group share.
AccessLevelStringFalseNoThe access level for the user or group on the shared object.
ScopeStringFalseNoThe scope of the share (ITEM or WORKSPACE).
CreatedAtDatetimeFalseNoTime that the share was created.
ModifiedAtDatetimeFalseNoTime that the share was modified.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoA unique identifier assigned to each template, ensuring it can be distinctly referenced.
NameStringFalseNoThe user-defined name of the template, used for display and identification purposes.
DescriptionStringFalseNoA detailed overview or summary of the template's purpose and contents.
TemplateTypeStringFalseNoSpecifies the type or category of the template, such as 'project plan' or 'budget sheet'.
AccessLevelStringFalseNoDefines the level of user permissions on the template, such as 'read-only' or 'editor'.
PermalinkStringFalseNoA permanent, unique URL linking directly to the template for easy sharing or access.
ImageStringFalseNoThe URL pointing to an image representing the template, often used in visual displays or previews.
LocaleStringFalseNoIndicates the language and region settings for the template, such as 'en-US' or 'fr-FR'.
FolderIdStringFalseNoThe unique identifier of the folder where the template is stored, helping to organize templates.
WorkspaceIdStringFalseNoThe unique identifier of the workspace containing the template, useful for multi-user collaboration.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoA unique identifier assigned to each user, used to differentiate them within the system.
AccountIdStringFalseNoThe unique identifier of the account to which the user belongs, establishing account association.
AccountNameStringFalseNoThe name of the account associated with the user, providing a human-readable reference.
EmailStringFalseNoThe email address registered for the user, used for communication and login purposes.
NameStringFalseNoThe user's full name as it appears in the system, combining first and last name.
FirstNameStringFalseNoThe user's first name, typically used in personal greetings and identification.
LastNameStringFalseNoThe user's last name, often used for formal identification.
AdminBooleanFalseNoIndicates whether the user is a system administrator with privileges to manage accounts and other users.
LocaleStringFalseNoThe language and regional settings associated with the user, impacting date formats and other locale-specific elements.
TimeZoneStringFalseNoThe user's timezone, used to localize date and time information across the platform.
LicensedSheetCreatorBooleanFalseNoIndicates if the user holds a license to create and own sheets within the system.
GroupAdminBooleanFalseNoSpecifies whether the user can create and manage groups, granting them group admin privileges.
ResourceViewerBooleanFalseNoIndicates if the user has access to view resource management features such as workload views.
StatusStringFalseNoThe current status of the user within the system. Possible values include: ACTIVE, PENDING, or DECLINED.
GroupIdStringFalseNoThe unique identifier of the group to which the user belongs, if applicable.
CompanyStringFalseNoThe name of the company the user is associated with. Populated only when filtering by user Id.
DepartmentStringFalseNoThe department within the company that the user is part of. Populated only when filtering by user Id.
MobilePhoneStringFalseNoThe user's mobile phone number. This field is populated only when filtering by user Id.
LastLoginStringFalseNoThe timestamp of the user's last login. Only populated if the user has logged in and an Id filter is applied.
RoleStringFalseNoThe role or position of the user within their organization. Populated only when filtering by user Id.
TitleStringFalseNoThe professional title of the user within their organization. Populated only when filtering by user Id.
WorkPhoneStringFalseNoThe user's work phone number. This field is populated only when filtering by user Id.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoA globally unique identifier (GUID) for the workspace, used to distinguish it from other workspaces.
NameStringFalseNoThe user-defined name of the workspace, used for organization and identification.
FavoriteBooleanFalseNoIndicates whether the workspace has been marked as a favorite by the user for quick access.
AccessLevelStringFalseNoSpecifies the permissions level assigned to the user for this workspace, such as Viewer, Editor, or Admin.
PermalinkStringFalseNoA permanent URL that provides a direct link to access the workspace within Smartsheet.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe unique identifier of this share.
WorkspaceId [KEY]StringFalseNoThe Id of the workspace.
TypeStringFalseNoThe type of this share. Possible values: USER or GROUP.
UserIdStringFalseNoThe user Id for a user share.
GroupIdStringFalseNoThe group Id of a group share.
EmailStringFalseNoThe email address for a user share.
NameStringFalseNoThe full name for a user share where the user is also a contact. The group name for a group share.
AccessLevelStringFalseNoThe access level for the user or group on the shared object.
ScopeStringFalseNoThe scope of the share (ITEM or WORKSPACE).
CreatedAtDatetimeFalseNoTime that the share was created.
ModifiedAtDatetimeFalseNoTime that the share was modified.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Sheet NameStringFalseNoThe name of the sheet representing sales activity and team objectives, providing a top-level identifier for the report.
PrimaryStringFalseNoThe primary column, typically used as a key identifier or main reference point for each row in the sales activity and objectives table.
ResponsibleStringFalseNoIndicates the individual or team responsible for the associated sales activity or objective, helping to assign accountability.
PaceStringFalseNoRepresents the pace at which sales activities are progressing, helping track velocity against goals.
Percent to GoalStringFalseNoShows the percentage completion towards the specified sales goals, aiding in performance tracking.
Due DateDatetimeFalseNoThe target completion date for the sales activity or objective, allowing for effective time management and planning.
ActualStringFalseNoRecords the actual performance or results achieved in the sales activity, enabling comparison with the target goals.
QuotaStringFalseNoSpecifies the target or quota assigned for the sales activity, serving as a benchmark for performance evaluation.
CommentsStringFalseNoProvides additional notes or remarks related to the sales activity or objectives, offering context or insights for each entry.
StateStringFalseNoDenotes the current status or condition of the sales activity, such as 'In Progress,' 'Completed,' or 'Pending.'

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RowId [KEY]StringFalseNoA unique identifier for each row in the sheet, corresponding to the RowId field in the Smartsheet API.
Sheet NameStringFalseNoThe name of the sheet this row belongs to, as retrieved from the Smartsheet API.
PrimaryStringFalseNoThe primary column for the sheet, used to identify the key attribute of each row.
Assigned ToStringFalseNoThe individual or team responsible for the task or event, as designated in the sheet.
CommentsStringFalseNoAdditional notes or comments provided for the task or event.
StatusStringFalseNoThe current status of the task or event, such as 'In Progress,' 'Completed,' or 'Not Started.'
DueDatetimeFalseNoThe due date and time for the task or event, formatted as a datetime object.
Due DateDatetimeFalseNoThe specific due date for the task or event without the time component.
BudgetStringFalseNoThe budget associated with the task or event, often used for financial tracking.
AssignedStringFalseNoThe person or entity to whom the task or event is currently assigned.
ActualStringFalseNoThe actual cost, time, or resource allocation for the task or event.
Notes & CommentsStringFalseNoDetailed notes and comments related to the task or event, providing additional context.
ReviewedBooleanFalseNoA boolean flag indicating whether the task or event has been reviewed (true or false).
ProgressStringFalseNoA textual or percentage-based indication of the task's progress, such as '50%' or 'Halfway Complete.'

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RowId [KEY]StringFalseNoThe unique identifier for a row in the sheet, used to track specific entries in the calendar.
PrioStringFalseNoIndicates the priority of the content, such as High, Medium, or Low, to assist in scheduling and resource allocation.
ImageStringFalseNoReferences the associated image file or URL, if any, for the content being planned.
Title & LinkStringFalseNoRepresents the title of the content and optionally includes a hyperlink to additional details or resources.
DetailsStringFalseNoProvides a detailed description of the content, including key themes or objectives.
Assigned ToStringFalseNoSpecifies the person or team responsible for creating or managing the content.
Draft DueDatetimeFalseNoThe deadline for submitting the draft version of the content, ensuring timely reviews.
Draft StatusStringFalseNoTracks the current progress of the draft, such as In Progress, Completed, or Pending Review.
Approved ByStringFalseNoRecords the name of the individual or group that approved the content for publication.
ObjectiveStringFalseNoDescribes the primary goal or purpose of the content, such as increasing engagement or promoting a product.
TargetStringFalseNoDefines the intended audience or demographic for the content.
Media TypeStringFalseNoCategorizes the content by type, such as Article, Video, or Social Media Post.
Art RequiredBooleanFalseNoIndicates whether custom artwork or graphics are needed for the content.
PlacementStringFalseNoSpecifies where the content will be published or distributed, such as a website, social media, or print.
Publication DateDatetimeFalseNoThe planned date for the content to go live or be released to the public.
KeywordsStringFalseNoLists relevant keywords for search optimization or content categorization.
LiveBooleanFalseNoIndicates whether the content has been published and is currently live.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RowId [KEY]StringFalseNoA unique identifier for each row in the order tracking history, corresponding to the API field for record identification.
POStringFalseNoThe purchase order number associated with the customer order, retrieved from the API.
PO DateDatetimeFalseNoThe date when the purchase order was created, as specified in the API data.
Ship DateDatetimeFalseNoThe date the order was shipped, sourced from the API field tracking shipment details.
Shipped ViaStringFalseNoThe shipping carrier or method used for the order, as recorded in the API.
Invoice AmountStringFalseNoThe total amount billed on the invoice for the order, provided by the API.
Invoice NumberStringFalseNoThe unique identifier for the invoice related to the order, matching the API data.
Inv DateDatetimeFalseNoThe date the invoice was generated for the order, as recorded in the API.
TermsStringFalseNoThe payment terms agreed upon for the invoice, as defined in the API.
PaidBooleanFalseNoIndicates whether the invoice has been fully paid (true) or not (false), based on API data.
Date PaidDatetimeFalseNoThe date when the invoice payment was completed, if applicable, from the API.
PaymentStringFalseNoDetails about the payment method or transaction used for settling the invoice, as sourced from the API.
Check #StringFalseNoThe check number associated with the payment, if a check was used, as recorded in the API.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RowId [KEY]StringFalseNoA unique identifier for each row, used to distinguish individual entries within the table.
Task NameStringFalseNoThe name or title of the task associated with this event plan, providing a clear descriptor of its purpose.
AssignedStringFalseNoThe individual or team responsible for completing the task, used to track accountability.
StatusStringFalseNoThe current state of the task, such as 'Not Started,' 'In Progress,' or 'Completed.'
ProgressStringFalseNoA visual or numerical representation of how much of the task has been completed.
$ EachStringFalseNoThis column is dynamic and maps to the corresponding field in the API.
QtyStringFalseNoThe quantity of items or resources required for the task, essential for accurate budgeting.
BudgetStringFalseNoThe allocated budget for the task, used to monitor financial planning.
ActualStringFalseNoThe actual amount spent on the task, allowing for budget versus actual comparisons.
CommentsStringFalseNoAdditional notes or details about the task, providing context or clarification.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RowId [KEY]StringFalseNoThe unique identifier for each row in the expense report sheet. Corresponds to the Row ID in the Smartsheet API.
DateDatetimeFalseNoThe date associated with the expense entry, formatted as a datetime value.
DescriptionStringFalseNoA brief description or note about the expense, such as its purpose or details.
Expense CategoryStringFalseNoThe category to which the expense belongs, such as Travel, Meals, or Office Supplies.
AmountStringFalseNoThe monetary value of the expense, stored as a string for API consistency.
Manager ApprovedBooleanFalseNoIndicates whether the manager has approved this expense (true or false).
CommentStringFalseNoAdditional comments or notes about the expense provided by the user or manager.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RowId [KEY]StringFalseNoA unique identifier for each row, used to reference the specific task or item in the API.
At RiskBooleanFalseNoIndicates whether the task is at risk of missing its deadline or completion target.
Task NameStringFalseNoThe name or title of the task, used for identifying and tracking work items.
Start DateDatetimeFalseNoThe planned start date and time for the task, critical for scheduling and dependencies.
End DateDatetimeFalseNoThe planned end date and time for the task, representing its deadline or completion target.
Assigned ToStringFalseNoThe name or unique identifier of the person or team assigned to complete the task.
StatusStringFalseNoThe current status of the task (for example, Not Started, In Progress, Completed).
DurationStringFalseNoThe total time allocated for the task, typically measured in days or hours.
% CompleteStringFalseNoThe percentage of the task that has been completed, useful for tracking progress.
PredecessorsStringFalseNoSpecifies tasks that must be completed before this task can start, helping to define dependencies.
CommentsStringFalseNoAdditional notes or information about the task, often used for collaboration or clarification.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RowId [KEY]StringFalseNoThe unique identifier for each row in the tracker, corresponding to a specific candidate record in the API.
Candidate NameStringFalseNoThe full name of the candidate being tracked in the hiring process.
Next StepsStringFalseNoDetails the upcoming actions or decisions required for the candidate, such as scheduling an interview or extending an offer.
CommentsStringFalseNoContains notes or remarks from hiring managers or interviewers about the candidate.
StatusStringFalseNoIndicates the current stage of the candidate in the hiring process, such as 'Applied', 'Interviewed', or 'Hired'.
RYGStringFalseNoRepresents a red-yellow-green status indicator to visually track candidate progress or priority.
Start DateDatetimeFalseNoThe proposed or confirmed start date for the candidate, if hired.
Hiring MgrStringFalseNoThe name of the hiring manager responsible for the candidate's recruitment process.
Referral SourceStringFalseNoIndicates how the candidate was sourced, such as 'Referral', 'Job Board', or 'Career Fair'.
Hire TypeStringFalseNoSpecifies the type of hire, such as 'Full-Time', 'Part-Time', 'Contractor', or 'Intern'.
CompensationStringFalseNoDetails the offered or agreed compensation package for the candidate, including salary or hourly rate.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RowId [KEY]StringFalseNoThe unique identifier for each row, dynamically mapped to the corresponding field in the API.
Monthly MetricStringFalseNoThe specific sales metric tracked for the month, dynamically linked to the API field.
QuotaStringFalseNoThe assigned sales target or goal for the month, pulled dynamically from the API.
ActualStringFalseNoThe actual sales performance achieved for the month, as recorded in the API.
Percent to GoalStringFalseNoThe percentage of the quota achieved for the month, dynamically calculated and mapped via the API.
VarianceStringFalseNoThe difference between the actual sales and the quota, indicating overachievement or shortfall.
PaceStringFalseNoThe rate of progress toward meeting the monthly sales goal, dynamically updated via the API.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RowId [KEY]StringFalseNoThe unique identifier for each row, corresponding to the unique field in the API.
StatusStringFalseNoRepresents the current state of the opportunity, such as Open, Closed, or In Progress.
Company LogoStringFalseNoStores the URL or file reference to the company's logo associated with the opportunity.
OpportunityStringFalseNoThe name or identifier of the sales opportunity being tracked.
Contact NameStringFalseNoFull name of the primary contact person for the opportunity.
Sales StageStringFalseNoIndicates the current stage in the sales pipeline, such as Qualification, Proposal, or Negotiation.
Forecast AmountStringFalseNoThe projected revenue amount for the opportunity.
ProbabilityStringFalseNoPercentage likelihood that the opportunity will be successfully closed.
Weighted ForecastStringFalseNoCalculated value of Forecast Amount multiplied by the Probability, representing the weighted revenue.
Expected Close DateDatetimeFalseNoThe date by which the opportunity is expected to close.
Sales RepStringFalseNoThe name of the sales representative responsible for the opportunity.
Next StepStringFalseNoDescribes the next action or task planned to progress the opportunity.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RowId [KEY]StringFalseNoA unique identifier for each row, corresponding to the Row ID field in the Smartsheet API.
Task NameStringFalseNoThe name or title of the task, used to identify objectives being tracked in the sheet.
ResponsibleStringFalseNoThe individual or team assigned responsibility for completing the task.
StateStringFalseNoThe current status of the task, such as 'Not Started,' 'In Progress,' or 'Completed.'
Due DateDatetimeFalseNoThe deadline for the task, represented as a date and time, used for scheduling and tracking purposes.
CommentsStringFalseNoAdditional notes or comments related to the task, providing context or updates for collaborators.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RowId [KEY]StringFalseNoThe unique identifier for each row in the task list, dynamically mapped to the corresponding field in the API.
RYGStringFalseNoIndicates the red-yellow-green (RYG) priority or status flag for a task, dynamically mapped to the corresponding field in the API.
TaskStringFalseNoThe title or name of the task, dynamically mapped to the corresponding field in the API.
Assigned ToStringFalseNoThe name or unique identifier of the individual or team responsible for the task, dynamically mapped to the corresponding field in the API.
ReviewedBooleanFalseNoA flag indicating whether the task has been reviewed, dynamically mapped to the corresponding field in the API.
StatusStringFalseNoThe current status of the task (for example, In Progress, Completed), dynamically mapped to the corresponding field in the API.
DueDatetimeFalseNoThe due date and time for the task, dynamically mapped to the corresponding field in the API.
Notes & CommentsStringFalseNoAdditional notes or comments related to the task, dynamically mapped to the corresponding field in the API.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RowId [KEY]StringFalseNoA unique identifier for each row, typically used to reference and track specific entries in the web form.
Form Field 1StringFalseNoRepresents the first field in the web form, typically used to collect user input or specific details.
Form Field 2StringFalseNoRepresents the second field in the web form, used to capture additional user-provided information.
Form Date FieldDatetimeFalseNoStores the date and time associated with the web form submission, providing a timestamp for tracking and analysis.

Return to Top