Module smartsheet
ballerinax/smartsheet Ballerina library
1.0.0
Overview
Smartsheet is a cloud-based platform that enables teams to plan, capture, manage, automate, and report on work at scale, empowering you to move from idea to impact, fast.
The ballerinax/smartsheet package offers APIs to connect and interact with Smartsheet API endpoints, specifically based on Smartsheet API v2.0.
Setup guide
To use the Smartsheet connector, you must have access to the Smartsheet API through a Smartsheet developer account and obtain an API access token. If you do not have a Smartsheet account, you can sign up for one here.
Step 1: Create a Smartsheet Account
-
Navigate to the Smartsheet website and sign up for an account or log in if you already have one.
-
Ensure you have a Business or Enterprise plan, as the Smartsheet API is restricted to users on these plans.
Step 2: Generate an API Access Token
-
Log in to your Smartsheet account.
-
On the left Navigation Bar at the bottom, select Account (your profile image), then Personal Settings.
-
In the new window, navigate to the API Access tab and select Generate new access token.
Tip: You must copy and store this key somewhere safe. It won't be visible again in your account settings for security reasons
Quickstart
To use the Smartsheet connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
Import the smartsheet module.
import ballerinax/smartsheet;
Step 2: Instantiate a new connector
- Create a
Config.tomlfile and configure the obtained access token as follows:
token = "<Your_Smartsheet_Access_Token>"
- Create a
smartsheet:ConnectionConfigwith the obtained access token and initialize the connector with it.
configurable string token = ?; final smartsheet:Client smartsheet = check new({ auth: { token } });
Step 3: Invoke the connector operation
Now, utilize the available connector operations.
Create a new sheet
public function main() returns error? { smartsheet:SheetsBody newSheet = { name: "New Project Sheet", columns: [ { title: "Task Name", type: "TEXT_NUMBER", primary: true }, { title: "Status", type: "PICKLIST", options: ["Not Started", "In Progress", "Complete"] }, { title: "Due Date", type: "DATE" } ] }; smartsheet:WebhookResponse response = check smartsheet->/sheets.post(newSheet); }
Step 4: Run the Ballerina application
bal run
Examples
The Smartsheet connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Project task management - Demonstrates how to automate project task creation using Ballerina connector for Smartsheet.
Clients
smartsheet: Client
Isolated
Welcome to the OpenAPI reference documentation for the Smartsheet API!
IMPORTANT:
- The Smartsheet API is restricted to users on Business and Enterprise plans
- The Developer Agreement governs the use of the Smartsheet API and Smartsheet software development kits (SDKs)
QUICKLINKS
- Base URL:
https://api.smartsheet.com/2.0/
-
Getting started: Generate an API access token and make a request.
-
Changelog: See the latest API updates.
-
Schemas: View the object schemas not explicitly listed in the resource sections.
-
Error codes: Look up common API error codes.
-
Guides: Learn various ways of using the API with the help of our Guides.
Browse the Smartsheet API operations by resource on the left and start building with the Smartsheet API!
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.smartsheet.com/2.0" - URL of the target service
get contacts
Isolated FunctionResource Function
function get contacts(ListContactsHeaders headers, *ListContactsQueries queries) returns ContactListResponse|errorList Contacts
Parameters
- headers ListContactsHeaders (default {}) - Headers to be sent with the request
- queries *ListContactsQueries - Queries to be sent with the request
Return Type
- ContactListResponse|error - IndexResult object containing an array of Contact objects
get contacts/[decimal contactId]
Isolated FunctionResource Function
function get contacts/[decimal contactId](GetContactHeaders headers, *GetContactQueries queries) returns Contact|errorGet Contact
Parameters
- headers GetContactHeaders (default {}) - Headers to be sent with the request
- queries *GetContactQueries - Queries to be sent with the request
get events
Isolated FunctionResource Function
function get events(ListEventsHeaders headers, *ListEventsQueries queries) returns EventStreamResponse|errorList events
Parameters
- headers ListEventsHeaders (default {}) - Headers to be sent with the request
- queries *ListEventsQueries - Queries to be sent with the request
Return Type
- EventStreamResponse|error - OK
get favorites
Isolated FunctionResource Function
function get favorites(GetFavoritesHeaders headers, *GetFavoritesQueries queries) returns ContactResponse|errorGet Favorites
Parameters
- headers GetFavoritesHeaders (default {}) - Headers to be sent with the request
- queries *GetFavoritesQueries - Queries to be sent with the request
Return Type
- ContactResponse|error - IndexResult object containing an array of Favorite objects
post favorites
Isolated FunctionResource Function
function post favorites(FavoritesBody payload, AddFavoriteHeaders headers) returns FavoriteResultResponse|errorAdd Favorites
Parameters
- payload FavoritesBody - A list of favorites to be added
- headers AddFavoriteHeaders (default {}) - Headers to be sent with the request
Return Type
- FavoriteResultResponse|error - Result object containing either a single Favorite object or an array of Favorite objects
delete favorites/["folder"|"report"|"sheet"|"sight"|"template"|"workspace" favoriteType]
Isolated FunctionResource Function
function delete favorites/["folder"|"report"|"sheet"|"sight"|"template"|"workspace" favoriteType](DeleteFavoritesByTypeHeaders headers, *DeleteFavoritesByTypeQueries queries) returns GenericResult|errorDelete Multiple Favorites
Parameters
- headers DeleteFavoritesByTypeHeaders (default {}) - Headers to be sent with the request
- queries *DeleteFavoritesByTypeQueries - Queries to be sent with the request
Return Type
- GenericResult|error - Returns Result object
get favorites/["folder"|"report"|"sheet"|"sight"|"template"|"workspace" favoriteType]/[decimal favoriteId]
Isolated FunctionResource Function
function get favorites/["folder"|"report"|"sheet"|"sight"|"template"|"workspace" favoriteType]/[decimal favoriteId](IsFavoriteHeaders headers, *IsFavoriteQueries queries) returns Favorite|errorIs Favorite
Parameters
- headers IsFavoriteHeaders (default {}) - Headers to be sent with the request
- queries *IsFavoriteQueries - Queries to be sent with the request
delete favorites/["folder"|"report"|"sheet"|"sight"|"template"|"workspace" favoriteType]/[decimal favoriteId]
Isolated FunctionResource Function
function delete favorites/["folder"|"report"|"sheet"|"sight"|"template"|"workspace" favoriteType]/[decimal favoriteId](DeleteFavoritesByTypeAndIdHeaders headers) returns GenericResult|errorDelete Favorite
Parameters
- headers DeleteFavoritesByTypeAndIdHeaders (default {}) - Headers to be sent with the request
Return Type
- GenericResult|error - Returns Result object
post filteredEvents
Isolated FunctionResource Function
function post filteredEvents(FilteredEventsRequest payload, ListFilteredEventsHeaders headers) returns EventFilterResponse|errorList filtered events
Parameters
- payload FilteredEventsRequest -
- headers ListFilteredEventsHeaders (default {}) - Headers to be sent with the request
Return Type
- EventFilterResponse|error - OK
get folders/[decimal folderId]
Isolated FunctionResource Function
function get folders/[decimal folderId](GetFolderHeaders headers, *GetFolderQueries queries) returns Folder|errorGet Folder
Parameters
- headers GetFolderHeaders (default {}) - Headers to be sent with the request
- queries *GetFolderQueries - Queries to be sent with the request
put folders/[decimal folderId]
Isolated FunctionResource Function
function put folders/[decimal folderId](Folder payload, UpdateFolderHeaders headers) returns CrossSheetReferenceResponse|errorUpdate Folder
Parameters
- payload Folder -
- headers UpdateFolderHeaders (default {}) - Headers to be sent with the request
Return Type
- CrossSheetReferenceResponse|error - Result object containing the modified Folder object
delete folders/[decimal folderId]
Isolated FunctionResource Function
function delete folders/[decimal folderId](DeleteFolderHeaders headers) returns GenericResult|errorDelete Folder
Parameters
- headers DeleteFolderHeaders (default {}) - Headers to be sent with the request
Return Type
- GenericResult|error - Returns Result object
post folders/[decimal folderId]/copy
Isolated FunctionResource Function
function post folders/[decimal folderId]/copy(FolderIdCopyBody payload, CopyFolderHeaders headers, *CopyFolderQueries queries) returns ContainerDestinationForCopy|errorCopy Folder
Parameters
- payload FolderIdCopyBody - New folder name
- headers CopyFolderHeaders (default {}) - Headers to be sent with the request
- queries *CopyFolderQueries - Queries to be sent with the request
Return Type
- ContainerDestinationForCopy|error - Result object containing a Folder object for the new folder destination
get folders/[decimal folderId]/folders
Isolated FunctionResource Function
function get folders/[decimal folderId]/folders(ListFoldersHeaders headers, *ListFoldersQueries queries) returns SearchResponse|errorList Folders
Parameters
- headers ListFoldersHeaders (default {}) - Headers to be sent with the request
- queries *ListFoldersQueries - Queries to be sent with the request
Return Type
- SearchResponse|error - IndexResult object containing an array of Folder objects
post folders/[decimal folderId]/folders
Isolated FunctionResource Function
function post folders/[decimal folderId]/folders(FolderIdFoldersBody payload, CreateFolderFolderHeaders headers, *CreateFolderFolderQueries queries) returns SharedSecretResponse|errorCreate Folder
Parameters
- payload FolderIdFoldersBody - Folder to create
- headers CreateFolderFolderHeaders (default {}) - Headers to be sent with the request
- queries *CreateFolderFolderQueries - Queries to be sent with the request
Return Type
- SharedSecretResponse|error - Result object containing a Folder object for newly created folder
post folders/[decimal folderId]/move
Isolated FunctionResource Function
function post folders/[decimal folderId]/move(FolderIdMoveBody payload, MoveFolderHeaders headers) returns ContainerDestinationForMove|errorMove Folder
Parameters
- payload FolderIdMoveBody - New folder destination
- headers MoveFolderHeaders (default {}) - Headers to be sent with the request
Return Type
- ContainerDestinationForMove|error - Result object containing a Folder object for the new folder destination
post folders/[decimal folderId]/sheets
Isolated FunctionResource Function
function post folders/[decimal folderId]/sheets(FolderIdSheetsBody payload, CreateSheetInFolderHeaders headers, *CreateSheetInFolderQueries queries) returns WebhookResponse|errorCreate Sheet in Folder
Parameters
- payload FolderIdSheetsBody - Sheet to create
- headers CreateSheetInFolderHeaders (default {}) - Headers to be sent with the request
- queries *CreateSheetInFolderQueries - Queries to be sent with the request
Return Type
- WebhookResponse|error - Result object containing a Sheet object for newly created sheet, corresponding to what was specified in the request
post folders/[decimal folderId]/sheets/'import
Isolated FunctionResource Function
function post folders/[decimal folderId]/sheets/'import(ImportSheetIntoFolderHeaders headers, byte[] payload, *ImportSheetIntoFolderQueries queries) returns WebhookListResponse|errorImport Sheet into Folder
Parameters
- headers ImportSheetIntoFolderHeaders - Headers to be sent with the request
- payload byte[] - Binary content for the CSV / XLSX file
- queries *ImportSheetIntoFolderQueries - Queries to be sent with the request
Return Type
- WebhookListResponse|error - Result object containing a Sheet object for imported sheet
get folders/personal
DeprecatedIsolated FunctionResource Function
function get folders/personal(ListHomeContentsHeaders headers, *ListHomeContentsQueries queries) returns Home|errorList Contents
Parameters
- headers ListHomeContentsHeaders (default {}) - Headers to be sent with the request
- queries *ListHomeContentsQueries - Queries to be sent with the request
Deprecated
get groups
Isolated FunctionResource Function
function get groups(ListGroupsHeaders headers, *ListGroupsQueries queries) returns GroupResponse|errorList Org Groups
Parameters
- headers ListGroupsHeaders (default {}) - Headers to be sent with the request
- queries *ListGroupsQueries - Queries to be sent with the request
Return Type
- GroupResponse|error - IndexResult object containing an array of Group objects
post groups
Isolated FunctionResource Function
function post groups(GroupCreate1 payload, AddGroupHeaders headers) returns GroupCreateResponse|errorAdd Group
Parameters
- payload GroupCreate1 - Group object, limited to the following attributes:
- headers AddGroupHeaders (default {}) - Headers to be sent with the request
Return Type
- GroupCreateResponse|error - Result object, containing a Group object for the newly created group
get groups/[decimal groupId]
Isolated FunctionResource Function
function get groups/[decimal groupId](GetGroupHeaders headers) returns GroupMembersResponse|errorGet Group
Parameters
- headers GetGroupHeaders (default {}) - Headers to be sent with the request
Return Type
- GroupMembersResponse|error - Group object that includes the list of GroupMember objects
put groups/[decimal groupId]
Isolated FunctionResource Function
function put groups/[decimal groupId](GroupUpdate1 payload, UpdateGroupHeaders headers) returns GroupCreateResponse|errorUpdate Group
Parameters
- payload GroupUpdate1 - Group object, limited to the following attributes:
- headers UpdateGroupHeaders (default {}) - Headers to be sent with the request
Return Type
- GroupCreateResponse|error - Result object containing the Group object for the updated group
delete groups/[decimal groupId]
Isolated FunctionResource Function
function delete groups/[decimal groupId](DeleteGroupHeaders headers) returns GenericResult|errorDelete Group
Parameters
- headers DeleteGroupHeaders (default {}) - Headers to be sent with the request
Return Type
- GenericResult|error - This operation is asynchronous, meaning group members may retain their sharing access for a brief period of time after the call returns. For small groups with limited sharing, the operation should complete quickly (within a few seconds). For large groups with many shares, this operation could possibly take more than a minute to complete.
post groups/[decimal groupId]/members
Isolated FunctionResource Function
function post groups/[decimal groupId]/members(GroupIdMembersBody payload, AddGroupMembersHeaders headers) returns GroupMembersListResponse|errorAdd Group Members
Parameters
- payload GroupIdMembersBody -
- headers AddGroupMembersHeaders (default {}) - Headers to be sent with the request
Return Type
- GroupMembersListResponse|error - Returns a Result object containing the members added to the group -- either a single GroupMember or array of GroupMember objects, corresponding to what was specified in the request. This operation is asynchronous, meaning the users may not yet have sharing access to sheets for a period of time after this operation returns. For small groups with limited sharing, the operation should complete quickly (within a few seconds). For large groups with many shares, this operation could possibly take more than a minute to complete.
delete groups/[decimal groupId]/members/[decimal userId]
Isolated FunctionResource Function
function delete groups/[decimal groupId]/members/[decimal userId](DeleteGroupMembersHeaders headers) returns GenericResult|errorDelete Group Members
Parameters
- headers DeleteGroupMembersHeaders (default {}) - Headers to be sent with the request
Return Type
- GenericResult|error - This operation is asynchronous, meaning the users may not yet have sharing access to sheets for a period of time after this operation returns. For small groups with limited sharing, the operation should complete quickly (within a few seconds). For large groups with many shares, this operation could possibly take more than a minute to complete.
get home/folders
Isolated FunctionResource Function
function get home/folders(HomeListFoldersHeaders headers, *HomeListFoldersQueries queries) returns SearchResponse|errorList Folders in Home
Parameters
- headers HomeListFoldersHeaders (default {}) - Headers to be sent with the request
- queries *HomeListFoldersQueries - Queries to be sent with the request
Return Type
- SearchResponse|error - IndexResult object containing an array of Folder objects
post home/folders
DeprecatedIsolated FunctionResource Function
function post home/folders(HomeFoldersBody payload, CreateHomeFolderHeaders headers) returns SharedSecretResponse|errorCreate Folder
Parameters
- payload HomeFoldersBody - Folder to create
- headers CreateHomeFolderHeaders (default {}) - Headers to be sent with the request
Return Type
- SharedSecretResponse|error - Result object containing a Folder object for newly created folder
Deprecated
post imageurls
Isolated FunctionResource Function
function post imageurls(InlineBodyItemsApplicationjsonimageurls[] payload, ListImageUrlsHeaders headers) returns ImageUrlMapResponse|errorList Image URLs
Parameters
- payload InlineBodyItemsApplicationjsonimageurls[] -
- headers ListImageUrlsHeaders (default {}) - Headers to be sent with the request
Return Type
- ImageUrlMapResponse|error - OK
get reports
Isolated FunctionResource Function
function get reports(GetReportsHeaders headers, *GetReportsQueries queries) returns TemplateListResponse|errorList Reports
Parameters
- headers GetReportsHeaders (default {}) - Headers to be sent with the request
- queries *GetReportsQueries - Queries to be sent with the request
Return Type
- TemplateListResponse|error - Object containing an array of all accessible reports, referenced by their ID, name, access level, and summary report flag values
get reports/[decimal reportId]
Isolated FunctionResource Function
function get reports/[decimal reportId](GetReportHeaders headers, *GetReportQueries queries) returns Report|errorGet Report
Parameters
- headers GetReportHeaders (default {}) - Headers to be sent with the request
- queries *GetReportQueries - Queries to be sent with the request
post reports/[decimal reportId]/emails
Isolated FunctionResource Function
function post reports/[decimal reportId]/emails(SheetEmail payload, SendReportViaEmailHeaders headers) returns Result|errorSend report via email
Parameters
- payload SheetEmail -
- headers SendReportViaEmailHeaders (default {}) - Headers to be sent with the request
get reports/[decimal reportId]/publish
Isolated FunctionResource Function
function get reports/[decimal reportId]/publish(GetReportPublishHeaders headers) returns ReportPublish|errorGets a Report's publish settings
Parameters
- headers GetReportPublishHeaders (default {}) - Headers to be sent with the request
Return Type
- ReportPublish|error - The Report's publish settings
put reports/[decimal reportId]/publish
Isolated FunctionResource Function
function put reports/[decimal reportId]/publish(ReportPublish payload, SetReportPublishHeaders headers) returns ReportPublishResponse|errorSet a Report's publish status
Parameters
- payload ReportPublish -
- headers SetReportPublishHeaders (default {}) - Headers to be sent with the request
Return Type
- ReportPublishResponse|error - ReportPublish object
get reports/[decimal reportId]/shares
Isolated FunctionResource Function
function get reports/[decimal reportId]/shares(ListReportSharesHeaders headers, *ListReportSharesQueries queries) returns PublicTemplateListResponse|errorList Report Shares
Parameters
- headers ListReportSharesHeaders (default {}) - Headers to be sent with the request
- queries *ListReportSharesQueries - Queries to be sent with the request
Return Type
- PublicTemplateListResponse|error - IndexResult object containing an array of Share objects. By default, this operation returns only item-level shares (scope=ITEM). Use the sharingInclude parameter to request that workspace-level shares (include=workspaceShares) also be returned
post reports/[decimal reportId]/shares
Isolated FunctionResource Function
function post reports/[decimal reportId]/shares(ReportIdSharesBody payload, ShareReportHeaders headers, *ShareReportQueries queries) returns TokenResponse|errorShare Report
Parameters
- payload ReportIdSharesBody -
- headers ShareReportHeaders (default {}) - Headers to be sent with the request
- queries *ShareReportQueries - Queries to be sent with the request
Return Type
- TokenResponse|error - Result object containing either a single Share object or an array of Share objects, corresponding to what was specified in the request. All shares have scope=ITEM
get reports/[decimal reportId]/shares/[string shareId]
Isolated FunctionResource Function
function get reports/[decimal reportId]/shares/[string shareId](ShareReportGetHeaders headers, *ShareReportGetQueries queries) returns Share|errorGet Report Share
Parameters
- headers ShareReportGetHeaders (default {}) - Headers to be sent with the request
- queries *ShareReportGetQueries - Queries to be sent with the request
put reports/[decimal reportId]/shares/[string shareId]
Isolated FunctionResource Function
function put reports/[decimal reportId]/shares/[string shareId](SharesshareIdBody payload, UpdateReportShareHeaders headers, *UpdateReportShareQueries queries) returns UserResponse|errorUpdate Report Share
Parameters
- payload SharesshareIdBody -
- headers UpdateReportShareHeaders (default {}) - Headers to be sent with the request
- queries *UpdateReportShareQueries - Queries to be sent with the request
Return Type
- UserResponse|error - Result object containing the modified Share object
delete reports/[decimal reportId]/shares/[string shareId]
Isolated FunctionResource Function
function delete reports/[decimal reportId]/shares/[string shareId](DeleteReportShareHeaders headers, *DeleteReportShareQueries queries) returns Result|errorDelete Report Share
Parameters
- headers DeleteReportShareHeaders (default {}) - Headers to be sent with the request
- queries *DeleteReportShareQueries - Queries to be sent with the request
get search
Isolated FunctionResource Function
function get search(ListSearchHeaders headers, *ListSearchQueries queries) returns UserCreateResponse|errorSearch Everything
Parameters
- headers ListSearchHeaders (default {}) - Headers to be sent with the request
- queries *ListSearchQueries - Queries to be sent with the request
Return Type
- UserCreateResponse|error - SearchResult object that contains an array of Search objects (maximum 100)
get search/sheets/[decimal sheetId]
Isolated FunctionResource Function
function get search/sheets/[decimal sheetId](ListSearchSheetHeaders headers, *ListSearchSheetQueries queries) returns AlternateEmailResponse|errorSearch Sheet
Parameters
- headers ListSearchSheetHeaders (default {}) - Headers to be sent with the request
- queries *ListSearchSheetQueries - Queries to be sent with the request
Return Type
- AlternateEmailResponse|error - SearchResult object containing an array of SearchResultItem objects in a sheet (maximum 100)
get serverinfo
Isolated FunctionResource Function
function get serverinfo(map<string|string[]> headers) returns ServerInfo|errorGets application constants.
Return Type
- ServerInfo|error - OK
get sheets
Isolated FunctionResource Function
function get sheets(ListSheetsHeaders headers, *ListSheetsQueries queries) returns AlternateEmailListResponse|errorList Sheets
Parameters
- headers ListSheetsHeaders (default {}) - Headers to be sent with the request
- queries *ListSheetsQueries - Queries to be sent with the request
Return Type
- AlternateEmailListResponse|error - SUCCESS
post sheets
DeprecatedIsolated FunctionResource Function
function post sheets(SheetsBody payload, CreateSheetInSheetsFolderHeaders headers, *CreateSheetInSheetsFolderQueries queries) returns WebhookResponse|errorCreate Sheet in "Sheets" Folder
Parameters
- payload SheetsBody - Sheet to create
- headers CreateSheetInSheetsFolderHeaders (default {}) - Headers to be sent with the request
- queries *CreateSheetInSheetsFolderQueries - Queries to be sent with the request
Return Type
- WebhookResponse|error - Result object containing a Sheet object for newly created sheet, corresponding to what was specified in the request
Deprecated
post sheets/'import
DeprecatedIsolated FunctionResource Function
function post sheets/'import(ImportSheetIntoSheetsFolderHeaders headers, byte[] payload, *ImportSheetIntoSheetsFolderQueries queries) returns WebhookListResponse|errorImport Sheet from CSV / XLSX
Parameters
- headers ImportSheetIntoSheetsFolderHeaders - Headers to be sent with the request
- payload byte[] - Binary content for the CSV / XLSX file
- queries *ImportSheetIntoSheetsFolderQueries - Queries to be sent with the request
Return Type
- WebhookListResponse|error - Result object containing a Sheet object for imported sheet
Deprecated
get sheets/[decimal sheetId]
Isolated FunctionResource Function
function get sheets/[decimal sheetId](GetSheetHeaders headers, *GetSheetQueries queries) returns FavoriteResponse|errorGet Sheet
Parameters
- headers GetSheetHeaders (default {}) - Headers to be sent with the request
- queries *GetSheetQueries - Queries to be sent with the request
Return Type
- FavoriteResponse|error - The Sheet that was loaded
put sheets/[decimal sheetId]
Isolated FunctionResource Function
function put sheets/[decimal sheetId](UpdateSheet payload, UpdateSheetHeaders headers, *UpdateSheetQueries queries) returns AttachmentListResponse|errorUpdate Sheet
Parameters
- payload UpdateSheet - Sheet object limited to the following attributes:
- headers UpdateSheetHeaders (default {}) - Headers to be sent with the request
- queries *UpdateSheetQueries - Queries to be sent with the request
Return Type
- AttachmentListResponse|error - Returns Result object containing a Sheet object for the updated sheet
delete sheets/[decimal sheetId]
Isolated FunctionResource Function
function delete sheets/[decimal sheetId](DeleteSheetHeaders headers) returns SuccessResult|errorDelete Sheet
Parameters
- headers DeleteSheetHeaders (default {}) - Headers to be sent with the request
Return Type
- SuccessResult|error - SUCCESS
get sheets/[decimal sheetId]/attachments
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/attachments(AttachmentsListOnSheetHeaders headers, *AttachmentsListOnSheetQueries queries) returns AttachmentVersionListResponse|errorList Attachments
Parameters
- headers AttachmentsListOnSheetHeaders (default {}) - Headers to be sent with the request
- queries *AttachmentsListOnSheetQueries - Queries to be sent with the request
Return Type
post sheets/[decimal sheetId]/attachments
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/attachments(byte[] payload, AttachmentsAttachToSheetHeaders headers) returns AttachmentVersionResponse|errorAttach File or URL to Sheet
Parameters
- payload byte[] -
- headers AttachmentsAttachToSheetHeaders (default {}) - Headers to be sent with the request
Return Type
- AttachmentVersionResponse|error - SUCCESS
get sheets/[decimal sheetId]/attachments/[string attachmentId]
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/attachments/[string attachmentId](AttachmentsGetHeaders headers) returns AttachmentResponse|errorGet Attachment
Parameters
- headers AttachmentsGetHeaders (default {}) - Headers to be sent with the request
Return Type
- AttachmentResponse|error - SUCCESS
delete sheets/[decimal sheetId]/attachments/[string attachmentId]
Isolated FunctionResource Function
function delete sheets/[decimal sheetId]/attachments/[string attachmentId](AttachmentsDeleteHeaders headers) returns GenericResult|errorDelete Attachment
Parameters
- headers AttachmentsDeleteHeaders (default {}) - Headers to be sent with the request
Return Type
- GenericResult|error - SUCCESS
get sheets/[decimal sheetId]/attachments/[string attachmentId]/versions
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/attachments/[string attachmentId]/versions(AttachmentsVersionListHeaders headers, *AttachmentsVersionListQueries queries) returns AttachmentVersionListResponse|errorList Versions
Parameters
- headers AttachmentsVersionListHeaders (default {}) - Headers to be sent with the request
- queries *AttachmentsVersionListQueries - Queries to be sent with the request
Return Type
post sheets/[decimal sheetId]/attachments/[string attachmentId]/versions
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/attachments/[string attachmentId]/versions(byte[] payload, AttachmentsVersionUploadHeaders headers) returns AttachmentVersionResponse|errorAttach New version
Parameters
- payload byte[] -
- headers AttachmentsVersionUploadHeaders (default {}) - Headers to be sent with the request
Return Type
- AttachmentVersionResponse|error - SUCCESS
delete sheets/[decimal sheetId]/attachments/[string attachmentId]/versions
Isolated FunctionResource Function
function delete sheets/[decimal sheetId]/attachments/[string attachmentId]/versions(AttachmentsVersionsDeleteHeaders headers) returns GenericResult|errorDelete All Versions
Parameters
- headers AttachmentsVersionsDeleteHeaders (default {}) - Headers to be sent with the request
Return Type
- GenericResult|error - SUCCESS
get sheets/[decimal sheetId]/automationrules
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/automationrules(AutomationrulesListHeaders headers, *AutomationrulesListQueries queries) returns AutomationRuleListResponse|errorList All Automation Rules
Parameters
- headers AutomationrulesListHeaders (default {}) - Headers to be sent with the request
- queries *AutomationrulesListQueries - Queries to be sent with the request
Return Type
- AutomationRuleListResponse|error - The list of AutomationRule objects
get sheets/[decimal sheetId]/automationrules/[string automationRuleId]
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/automationrules/[string automationRuleId](AutomationruleGetHeaders headers) returns AutomationRuleResponse|errorGet an Automation Rule
Parameters
- headers AutomationruleGetHeaders (default {}) - Headers to be sent with the request
Return Type
- AutomationRuleResponse|error - AutomationRule object
put sheets/[decimal sheetId]/automationrules/[string automationRuleId]
Isolated FunctionResource Function
function put sheets/[decimal sheetId]/automationrules/[string automationRuleId](AutomationRule payload, AutomationruleUpdateHeaders headers) returns AutomationRuleUpdateResponse|errorUpdate an Automation Rule
Parameters
- payload AutomationRule -
- headers AutomationruleUpdateHeaders (default {}) - Headers to be sent with the request
Return Type
- AutomationRuleUpdateResponse|error - Result object containing the updated AutomationRule object
delete sheets/[decimal sheetId]/automationrules/[string automationRuleId]
Isolated FunctionResource Function
function delete sheets/[decimal sheetId]/automationrules/[string automationRuleId](AutomationruleDeleteHeaders headers) returns Result|errorDelete an Automation Rule
Parameters
- headers AutomationruleDeleteHeaders (default {}) - Headers to be sent with the request
get sheets/[decimal sheetId]/columns
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/columns(ColumnsListOnSheetHeaders headers, *ColumnsListOnSheetQueries queries) returns ColumnListResponse|errorList Columns
Parameters
- headers ColumnsListOnSheetHeaders (default {}) - Headers to be sent with the request
- queries *ColumnsListOnSheetQueries - Queries to be sent with the request
Return Type
- ColumnListResponse|error - Returns IndexResult object containing an array of Column objects
post sheets/[decimal sheetId]/columns
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/columns(ColumnObjectAttributes payload, ColumnsAddToSheetHeaders headers) returns ColumnCreateResponse|errorAdd Columns
Parameters
- payload ColumnObjectAttributes - A Column object that contains the following attributes
- headers ColumnsAddToSheetHeaders (default {}) - Headers to be sent with the request
Return Type
- ColumnCreateResponse|error - Returns Result object containing the newly created columns -- either a single Column object or an array of Column objects, corresponding to what was specified in the request
get sheets/[decimal sheetId]/columns/[decimal columnId]
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/columns/[decimal columnId](ColumnGetHeaders headers, *ColumnGetQueries queries) returns ColumnResponse|errorGet Column
Parameters
- headers ColumnGetHeaders (default {}) - Headers to be sent with the request
- queries *ColumnGetQueries - Queries to be sent with the request
Return Type
- ColumnResponse|error - SUCCESS
put sheets/[decimal sheetId]/columns/[decimal columnId]
Isolated FunctionResource Function
function put sheets/[decimal sheetId]/columns/[decimal columnId](ColumnObjectAttributes payload, ColumnUpdateColumnHeaders headers) returns ColumnUpdateResponse|errorUpdate Column
Parameters
- payload ColumnObjectAttributes - A Column object that contains the following attributes:
- headers ColumnUpdateColumnHeaders (default {}) - Headers to be sent with the request
Return Type
- ColumnUpdateResponse|error - Returns Result object containing the Column object that was modified
delete sheets/[decimal sheetId]/columns/[decimal columnId]
Isolated FunctionResource Function
function delete sheets/[decimal sheetId]/columns/[decimal columnId](ColumnDeleteHeaders headers) returns GenericResult|errorDelete Column
Parameters
- headers ColumnDeleteHeaders (default {}) - Headers to be sent with the request
Return Type
- GenericResult|error - SUCCESS
get sheets/[decimal sheetId]/comments/[string commentId]
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/comments/[string commentId](CommentGetHeaders headers) returns CommentResponse|errorGet a comment
Parameters
- headers CommentGetHeaders (default {}) - Headers to be sent with the request
Return Type
- CommentResponse|error - SUCCESS
put sheets/[decimal sheetId]/comments/[string commentId]
Isolated FunctionResource Function
function put sheets/[decimal sheetId]/comments/[string commentId](CommentCreationRequest payload, CommentEditHeaders headers) returns CommentCreateResponse|errorEdit a comment
Parameters
- payload CommentCreationRequest -
- headers CommentEditHeaders (default {}) - Headers to be sent with the request
Return Type
- CommentCreateResponse|error - SUCCESS
delete sheets/[decimal sheetId]/comments/[string commentId]
Isolated FunctionResource Function
function delete sheets/[decimal sheetId]/comments/[string commentId](CommentDeleteHeaders headers) returns CommentUpdateResponse|errorDelete a comment
Parameters
- headers CommentDeleteHeaders (default {}) - Headers to be sent with the request
Return Type
- CommentUpdateResponse|error - SUCCESS
post sheets/[decimal sheetId]/comments/[string commentId]/attachments
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/comments/[string commentId]/attachments(byte[] payload, AttachmentsAttachToCommentHeaders headers) returns AttachmentVersionResponse|errorAttach File or URL to Comment
Parameters
- payload byte[] -
- headers AttachmentsAttachToCommentHeaders (default {}) - Headers to be sent with the request
Return Type
- AttachmentVersionResponse|error - SUCCESS
post sheets/[decimal sheetId]/copy
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/copy(ContainerDestinationForCopy payload, CopySheetHeaders headers, *CopySheetQueries queries) returns CrossSheetReferenceListResponse|errorCopy Sheet
Parameters
- payload ContainerDestinationForCopy - Destination where to create a copy of the specified sheet
- headers CopySheetHeaders (default {}) - Headers to be sent with the request
- queries *CopySheetQueries - Queries to be sent with the request
Return Type
- CrossSheetReferenceListResponse|error - SUCCESS
get sheets/[decimal sheetId]/crosssheetreferences
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/crosssheetreferences(ListCrosssheetReferencesHeaders headers, *ListCrosssheetReferencesQueries queries) returns CrossSheetReferenceCreateResponse|errorList Cross-sheet References
Parameters
- headers ListCrosssheetReferencesHeaders (default {}) - Headers to be sent with the request
- queries *ListCrosssheetReferencesQueries - Queries to be sent with the request
Return Type
- CrossSheetReferenceCreateResponse|error - IndexResult object containing an array of CrossSheetReference objects
post sheets/[decimal sheetId]/crosssheetreferences
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/crosssheetreferences(SheetIdCrosssheetreferencesBody payload, AddCrosssheetReferenceHeaders headers) returns DiscussionListResponse|errorCreate Cross-sheet References
Parameters
- payload SheetIdCrosssheetreferencesBody - CrossSheetReference object to create
- headers AddCrosssheetReferenceHeaders (default {}) - Headers to be sent with the request
Return Type
- DiscussionListResponse|error - Result object containing a CrossSheetReference object, corresponding to what was specified in the request
get sheets/[decimal sheetId]/crosssheetreferences/[decimal crossSheetReferenceId]
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/crosssheetreferences/[decimal crossSheetReferenceId](GetCrosssheetReferenceHeaders headers) returns CrossSheetReference|errorGet Cross-sheet Reference
Parameters
- headers GetCrosssheetReferenceHeaders (default {}) - Headers to be sent with the request
Return Type
- CrossSheetReference|error - CrossSheetReference object
get sheets/[decimal sheetId]/discussions
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/discussions(DiscussionsListHeaders headers, *DiscussionsListQueries queries) returns DiscussionCreateResponse|errorList Discussions
Parameters
- headers DiscussionsListHeaders (default {}) - Headers to be sent with the request
- queries *DiscussionsListQueries - Queries to be sent with the request
Return Type
post sheets/[decimal sheetId]/discussions
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/discussions(DiscussionCreationRequest payload, DiscussionsCreateHeaders headers) returns DiscussionAttachmentListResponse|errorCreate a Discussion
Parameters
- payload DiscussionCreationRequest -
- headers DiscussionsCreateHeaders (default {}) - Headers to be sent with the request
Return Type
- DiscussionAttachmentListResponse|error - SUCCESS
get sheets/[decimal sheetId]/discussions/[string discussionId]
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/discussions/[string discussionId](DiscussionGetHeaders headers) returns DiscussionResponse|errorGet Discussion
Parameters
- headers DiscussionGetHeaders (default {}) - Headers to be sent with the request
Return Type
- DiscussionResponse|error - SUCCESS
delete sheets/[decimal sheetId]/discussions/[string discussionId]
Isolated FunctionResource Function
function delete sheets/[decimal sheetId]/discussions/[string discussionId](DiscussionDeleteHeaders headers) returns GenericResult|errorDelete a Discussion
Parameters
- headers DiscussionDeleteHeaders (default {}) - Headers to be sent with the request
Return Type
- GenericResult|error - SUCCESS
get sheets/[decimal sheetId]/discussions/[string discussionId]/attachments
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/discussions/[string discussionId]/attachments(DiscussionListAttachmentsHeaders headers, *DiscussionListAttachmentsQueries queries) returns AttachmentVersionListResponse|errorList Discussion Attachments
Parameters
- headers DiscussionListAttachmentsHeaders (default {}) - Headers to be sent with the request
- queries *DiscussionListAttachmentsQueries - Queries to be sent with the request
Return Type
post sheets/[decimal sheetId]/discussions/[string discussionId]/comments
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/discussions/[string discussionId]/comments(CommentCreationRequest payload, CommentsCreateHeaders headers) returns ProofListResponse|errorCreate a comment
Parameters
- payload CommentCreationRequest -
- headers CommentsCreateHeaders (default {}) - Headers to be sent with the request
Return Type
- ProofListResponse|error - SUCCESS
post sheets/[decimal sheetId]/emails
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/emails(SheetEmail payload, SheetSendHeaders headers) returns ProofCreateResponse|errorSend Sheet via Email
Parameters
- payload SheetEmail - SheetEmail object
- headers SheetSendHeaders (default {}) - Headers to be sent with the request
Return Type
- ProofCreateResponse|error - SUCCESS
post sheets/[decimal sheetId]/move
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/move(ContainerDestinationForMove payload, MoveSheetHeaders headers) returns CrossSheetReferenceListResponse|errorMove Sheet
Parameters
- payload ContainerDestinationForMove - Destination to move the specified sheet
- headers MoveSheetHeaders (default {}) - Headers to be sent with the request
Return Type
- CrossSheetReferenceListResponse|error - SUCCESS
get sheets/[decimal sheetId]/proofs
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/proofs(ProofsGetAllProofsHeaders headers, *ProofsGetAllProofsQueries queries) returns ProofDetailListResponse|errorList Proofs
Parameters
- headers ProofsGetAllProofsHeaders (default {}) - Headers to be sent with the request
- queries *ProofsGetAllProofsQueries - Queries to be sent with the request
Return Type
get sheets/[decimal sheetId]/proofs/[string proofId]
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/proofs/[string proofId](ProofsGetHeaders headers, *ProofsGetQueries queries) returns ProofResponse|errorGet Proof
Parameters
- headers ProofsGetHeaders (default {}) - Headers to be sent with the request
- queries *ProofsGetQueries - Queries to be sent with the request
Return Type
- ProofResponse|error - SUCCESS
put sheets/[decimal sheetId]/proofs/[string proofId]
Isolated FunctionResource Function
function put sheets/[decimal sheetId]/proofs/[string proofId](UpdateProofStatusRequest payload, ProofsUpdateHeaders headers) returns ProofResponse|errorUpdate Proof Status
Parameters
- payload UpdateProofStatusRequest -
- headers ProofsUpdateHeaders (default {}) - Headers to be sent with the request
Return Type
- ProofResponse|error - SUCCESS
delete sheets/[decimal sheetId]/proofs/[string proofId]
Isolated FunctionResource Function
function delete sheets/[decimal sheetId]/proofs/[string proofId](ProofsDeleteHeaders headers) returns GenericResult|errorDelete Proof
Parameters
- headers ProofsDeleteHeaders (default {}) - Headers to be sent with the request
Return Type
- GenericResult|error - SUCCESS
get sheets/[decimal sheetId]/proofs/[string proofId]/attachments
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/proofs/[string proofId]/attachments(ProofsListAttachmentsHeaders headers, *ProofsListAttachmentsQueries queries) returns ProofAttachmentListResponse|errorList Proof Attachments
Parameters
- headers ProofsListAttachmentsHeaders (default {}) - Headers to be sent with the request
- queries *ProofsListAttachmentsQueries - Queries to be sent with the request
Return Type
post sheets/[decimal sheetId]/proofs/[string proofId]/attachments
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/proofs/[string proofId]/attachments(byte[] payload, ProofsAttachToProofHeaders headers) returns AttachmentVersionResponse|errorAttach File to Proof
Parameters
- payload byte[] -
- headers ProofsAttachToProofHeaders (default {}) - Headers to be sent with the request
Return Type
- AttachmentVersionResponse|error - SUCCESS
get sheets/[decimal sheetId]/proofs/[string proofId]/discussions
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/proofs/[string proofId]/discussions(ProofsListDiscussionsHeaders headers, *ProofsListDiscussionsQueries queries) returns ProofDiscussionListResponse|errorList Proof Discussions
Parameters
- headers ProofsListDiscussionsHeaders (default {}) - Headers to be sent with the request
- queries *ProofsListDiscussionsQueries - Queries to be sent with the request
Return Type
post sheets/[decimal sheetId]/proofs/[string proofId]/discussions
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/proofs/[string proofId]/discussions(DiscussionCreationRequest payload, ProofsCreateDiscussionHeaders headers) returns DiscussionAttachmentListResponse|errorCreate Proof Discussion
Parameters
- payload DiscussionCreationRequest -
- headers ProofsCreateDiscussionHeaders (default {}) - Headers to be sent with the request
Return Type
- DiscussionAttachmentListResponse|error - SUCCESS
get sheets/[decimal sheetId]/proofs/[string proofId]/requestactions
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/proofs/[string proofId]/requestactions(ProofsListRequestActionsHeaders headers, *ProofsListRequestActionsQueries queries) returns ProofRequestActionListResponse|errorList Proof Request Actions
Parameters
- headers ProofsListRequestActionsHeaders (default {}) - Headers to be sent with the request
- queries *ProofsListRequestActionsQueries - Queries to be sent with the request
Return Type
post sheets/[decimal sheetId]/proofs/[string proofId]/requests
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/proofs/[string proofId]/requests(ProofRequestBody payload, ProofsCreateProofRequestsHeaders headers) returns ProofRequestCreateResponse|errorCreate Proof Request
Parameters
- payload ProofRequestBody -
- headers ProofsCreateProofRequestsHeaders (default {}) - Headers to be sent with the request
Return Type
- ProofRequestCreateResponse|error - SUCCESS
delete sheets/[decimal sheetId]/proofs/[string proofId]/requests
Isolated FunctionResource Function
function delete sheets/[decimal sheetId]/proofs/[string proofId]/requests(ProofsDeleteProofRequestsHeaders headers) returns GenericResult|errorDelete Proof Requests
Parameters
- headers ProofsDeleteProofRequestsHeaders (default {}) - Headers to be sent with the request
Return Type
- GenericResult|error - SUCCESS
get sheets/[decimal sheetId]/proofs/[string proofId]/versions
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/proofs/[string proofId]/versions(ProofsGetVersionsHeaders headers, *ProofsGetVersionsQueries queries) returns ProofVersionListResponse|errorList Proof Versions
Parameters
- headers ProofsGetVersionsHeaders (default {}) - Headers to be sent with the request
- queries *ProofsGetVersionsQueries - Queries to be sent with the request
Return Type
post sheets/[decimal sheetId]/proofs/[string proofId]/versions
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/proofs/[string proofId]/versions(byte[] payload, ProofsCreateVersionHeaders headers) returns ProofVersionResponse|errorCreate Proof Version
Parameters
- payload byte[] -
- headers ProofsCreateVersionHeaders (default {}) - Headers to be sent with the request
Return Type
- ProofVersionResponse|error - SUCCESS
delete sheets/[decimal sheetId]/proofs/[string proofId]/versions
Isolated FunctionResource Function
function delete sheets/[decimal sheetId]/proofs/[string proofId]/versions(ProofsDeleteVersionHeaders headers) returns GenericResult|errorDelete Proof Version
Parameters
- headers ProofsDeleteVersionHeaders (default {}) - Headers to be sent with the request
Return Type
- GenericResult|error - SUCCESS
get sheets/[decimal sheetId]/publish
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/publish(GetSheetPublishHeaders headers) returns SheetPublish|errorGet Sheet Publish Status
Parameters
- headers GetSheetPublishHeaders (default {}) - Headers to be sent with the request
Return Type
- SheetPublish|error - OK
put sheets/[decimal sheetId]/publish
Isolated FunctionResource Function
function put sheets/[decimal sheetId]/publish(SheetPublishRequest payload, SetSheetPublishHeaders headers) returns SheetPublishResponse|errorSet Sheet Publish Status
Parameters
- payload SheetPublishRequest - SheetPublish object
- headers SetSheetPublishHeaders (default {}) - Headers to be sent with the request
Return Type
put sheets/[decimal sheetId]/rows
Isolated FunctionResource Function
function put sheets/[decimal sheetId]/rows(SheetIdRowsBody payload, UpdateRowsHeaders headers, *UpdateRowsQueries queries) returns RowCopyResponse|errorUpdate Rows
Parameters
- payload SheetIdRowsBody - Row object or an array of Row objects, with the following attributes:
- headers UpdateRowsHeaders (default {}) - Headers to be sent with the request
- queries *UpdateRowsQueries - Queries to be sent with the request
Return Type
- RowCopyResponse|error - Returns Result object containing an array of the updated rows
post sheets/[decimal sheetId]/rows
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/rows(SheetIdRowsBody1 payload, RowsAddToSheetHeaders headers, *RowsAddToSheetQueries queries) returns RowMoveResponse|errorAdd Rows
Parameters
- payload SheetIdRowsBody1 - Row object or an array of Row objects, with the following attributes:
- headers RowsAddToSheetHeaders (default {}) - Headers to be sent with the request
- queries *RowsAddToSheetQueries - Queries to be sent with the request
Return Type
- RowMoveResponse|error - Returns Result object containing the newly created rows -- either a single Row object or array of Row objects, corresponding to what was specified in the request, as well as the new version of the sheet
delete sheets/[decimal sheetId]/rows
Isolated FunctionResource Function
function delete sheets/[decimal sheetId]/rows(DeleteRowsHeaders headers, *DeleteRowsQueries queries) returns RowListResponse|errorDelete Rows
Parameters
- headers DeleteRowsHeaders (default {}) - Headers to be sent with the request
- queries *DeleteRowsQueries - Queries to be sent with the request
Return Type
- RowListResponse|error - Returns Result object containing row Ids corresponding to all rows that were successfully deleted (including any child rows of rows specified in the URL)
post sheets/[decimal sheetId]/rows/emails
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/rows/emails(MultiRowEmail payload, RowsSendHeaders headers) returns ProofCreateResponse|errorSend Rows via Email
Parameters
- payload MultiRowEmail - The columns included for each row in the email are populated according to the following rules:
- headers RowsSendHeaders (default {}) - Headers to be sent with the request
Return Type
- ProofCreateResponse|error - SUCCESS
post sheets/[decimal sheetId]/rows/copy
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/rows/copy(CopyOrMoveRowDirective payload, CopyRowsHeaders headers, *CopyRowsQueries queries) returns CopyOrMoveRowResult|errorCopy Rows to Another Sheet
Parameters
- payload CopyOrMoveRowDirective -
- headers CopyRowsHeaders (default {}) - Headers to be sent with the request
- queries *CopyRowsQueries - Queries to be sent with the request
Return Type
- CopyOrMoveRowResult|error - CopyOrMoveRowResult object
post sheets/[decimal sheetId]/rows/move
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/rows/move(CopyOrMoveRowDirective payload, MoveRowsHeaders headers, *MoveRowsQueries queries) returns CopyOrMoveRowResult|errorMove Rows to Another Sheet
Parameters
- payload CopyOrMoveRowDirective -
- headers MoveRowsHeaders (default {}) - Headers to be sent with the request
- queries *MoveRowsQueries - Queries to be sent with the request
Return Type
- CopyOrMoveRowResult|error - CopyOrMoveRowResult object
get sheets/[decimal sheetId]/rows/[decimal rowId]
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/rows/[decimal rowId](RowGetHeaders headers, *RowGetQueries queries) returns RowResponse|errorGet Row
Parameters
- headers RowGetHeaders (default {}) - Headers to be sent with the request
- queries *RowGetQueries - Queries to be sent with the request
Return Type
- RowResponse|error - Returns Row object populated according to the specified parameters
get sheets/[decimal sheetId]/rows/[decimal rowId]/attachments
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/rows/[decimal rowId]/attachments(AttachmentsListOnRowHeaders headers, *AttachmentsListOnRowQueries queries) returns AttachmentVersionListResponse|errorList Row Attachments
Parameters
- headers AttachmentsListOnRowHeaders (default {}) - Headers to be sent with the request
- queries *AttachmentsListOnRowQueries - Queries to be sent with the request
Return Type
post sheets/[decimal sheetId]/rows/[decimal rowId]/attachments
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/rows/[decimal rowId]/attachments(byte[] payload, RowAttachmentsAttachFileHeaders headers) returns AttachmentVersionResponse|errorAttach File or URL to Row
Parameters
- payload byte[] -
- headers RowAttachmentsAttachFileHeaders (default {}) - Headers to be sent with the request
Return Type
- AttachmentVersionResponse|error - SUCCESS
post sheets/[decimal sheetId]/rows/[decimal rowId]/columns/[decimal columnId]/cellimages
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/rows/[decimal rowId]/columns/[decimal columnId]/cellimages(byte[] payload, AddImageToCellHeaders headers, *AddImageToCellQueries queries) returns RowCreateResponse|errorAdd Image to Cell
Parameters
- payload byte[] -
- headers AddImageToCellHeaders (default {}) - Headers to be sent with the request
- queries *AddImageToCellQueries - Queries to be sent with the request
Return Type
- RowCreateResponse|error - SUCCESS
get sheets/[decimal sheetId]/rows/[decimal rowId]/columns/[decimal columnId]/history
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/rows/[decimal rowId]/columns/[decimal columnId]/history(CellHistoryGetHeaders headers, *CellHistoryGetQueries queries) returns RowAttachmentListResponse|errorList Cell History
Parameters
- headers CellHistoryGetHeaders (default {}) - Headers to be sent with the request
- queries *CellHistoryGetQueries - Queries to be sent with the request
Return Type
get sheets/[decimal sheetId]/rows/[decimal rowId]/discussions
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/rows/[decimal rowId]/discussions(RowDiscussionsListHeaders headers, *RowDiscussionsListQueries queries) returns DiscussionCreateResponse|errorList Discussions with a Row
Parameters
- headers RowDiscussionsListHeaders (default {}) - Headers to be sent with the request
- queries *RowDiscussionsListQueries - Queries to be sent with the request
Return Type
post sheets/[decimal sheetId]/rows/[decimal rowId]/discussions
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/rows/[decimal rowId]/discussions(DiscussionCreationRequest payload, RowDiscussionsCreateHeaders headers) returns DiscussionAttachmentListResponse|errorCreate a Discussion on a Row
Parameters
- payload DiscussionCreationRequest -
- headers RowDiscussionsCreateHeaders (default {}) - Headers to be sent with the request
Return Type
- DiscussionAttachmentListResponse|error - SUCCESS
post sheets/[decimal sheetId]/rows/[decimal rowId]/proofs
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/rows/[decimal rowId]/proofs(byte[] payload, ProofsCreateHeaders headers) returns ProofVersionResponse|errorCreate Proof
Parameters
- payload byte[] -
- headers ProofsCreateHeaders (default {}) - Headers to be sent with the request
Return Type
- ProofVersionResponse|error - SUCCESS
get sheets/[decimal sheetId]/sentupdaterequests
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/sentupdaterequests(SentupdaterequestsListHeaders headers, *SentupdaterequestsListQueries queries) returns SentUpdateRequestListResponse|errorList Sent Update Requests
Parameters
- headers SentupdaterequestsListHeaders (default {}) - Headers to be sent with the request
- queries *SentupdaterequestsListQueries - Queries to be sent with the request
Return Type
- SentUpdateRequestListResponse|error - The list of SentUpdateRequest objects
get sheets/[decimal sheetId]/sentupdaterequests/[string sentUpdateRequestId]
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/sentupdaterequests/[string sentUpdateRequestId](SentupdaterequestGetHeaders headers) returns SentUpdateRequest|errorGet Sent Update Request
Parameters
- headers SentupdaterequestGetHeaders (default {}) - Headers to be sent with the request
Return Type
- SentUpdateRequest|error - SentUpdateRequest object
delete sheets/[decimal sheetId]/sentupdaterequests/[string sentUpdateRequestId]
Isolated FunctionResource Function
function delete sheets/[decimal sheetId]/sentupdaterequests/[string sentUpdateRequestId](SentupdaterequestDeleteHeaders headers) returns Result|errorDelete Sent Update Request
Parameters
- headers SentupdaterequestDeleteHeaders (default {}) - Headers to be sent with the request
get sheets/[decimal sheetId]/summary
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/summary(ListSummaryFieldsHeaders headers, *ListSummaryFieldsQueries queries) returns SheetSummary|errorGet Sheet Summary
Parameters
- headers ListSummaryFieldsHeaders (default {}) - Headers to be sent with the request
- queries *ListSummaryFieldsQueries - Queries to be sent with the request
Return Type
- SheetSummary|error - OK
get sheets/[decimal sheetId]/summary/fields
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/summary/fields(ListSummaryFieldsPaginatedHeaders headers, *ListSummaryFieldsPaginatedQueries queries) returns SummaryFieldListResponse|errorGet Summary Fields
Parameters
- headers ListSummaryFieldsPaginatedHeaders (default {}) - Headers to be sent with the request
- queries *ListSummaryFieldsPaginatedQueries - Queries to be sent with the request
Return Type
put sheets/[decimal sheetId]/summary/fields
Isolated FunctionResource Function
function put sheets/[decimal sheetId]/summary/fields(SummaryFieldUpdateRequest[] payload, UpdateSummaryFieldsHeaders headers, *UpdateSummaryFieldsQueries queries) returns SummaryFieldCreateResponse|errorUpdate Summary Fields
Parameters
- payload SummaryFieldUpdateRequest[] - Array of SummaryField objects
- headers UpdateSummaryFieldsHeaders (default {}) - Headers to be sent with the request
- queries *UpdateSummaryFieldsQueries - Queries to be sent with the request
Return Type
post sheets/[decimal sheetId]/summary/fields
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/summary/fields(SummaryFieldCreateRequest[] payload, AddSummaryFieldsHeaders headers, *AddSummaryFieldsQueries queries) returns SummaryFieldBulkCreateResponse|errorAdd Summary Fields
Parameters
- payload SummaryFieldCreateRequest[] - Array of SummaryField objects
- headers AddSummaryFieldsHeaders (default {}) - Headers to be sent with the request
- queries *AddSummaryFieldsQueries - Queries to be sent with the request
Return Type
delete sheets/[decimal sheetId]/summary/fields
Isolated FunctionResource Function
function delete sheets/[decimal sheetId]/summary/fields(DeleteSummaryFieldsHeaders headers, *DeleteSummaryFieldsQueries queries) returns SummaryFieldDeleteResponse|errorDelete Summary Fields
Parameters
- headers DeleteSummaryFieldsHeaders (default {}) - Headers to be sent with the request
- queries *DeleteSummaryFieldsQueries - Queries to be sent with the request
Return Type
post sheets/[decimal sheetId]/summary/fields/[decimal fieldId]/images
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/summary/fields/[decimal fieldId]/images(byte[] payload, AddImageSummaryFieldHeaders headers, *AddImageSummaryFieldQueries queries) returns SummaryResponse|errorAdd Image to Sheet Summary
Parameters
- payload byte[] -
- headers AddImageSummaryFieldHeaders (default {}) - Headers to be sent with the request
- queries *AddImageSummaryFieldQueries - Queries to be sent with the request
Return Type
- SummaryResponse|error - SUCCESS
get sheets/[decimal sheetId]/updaterequests
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/updaterequests(UpdaterequestsListHeaders headers, *UpdaterequestsListQueries queries) returns UpdateRequestListResponse|errorList Update Requests
Parameters
- headers UpdaterequestsListHeaders (default {}) - Headers to be sent with the request
- queries *UpdaterequestsListQueries - Queries to be sent with the request
Return Type
- UpdateRequestListResponse|error - The list of UpdateRequest objects
post sheets/[decimal sheetId]/updaterequests
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/updaterequests(UpdateRequest payload, UpdaterequestsCreateHeaders headers) returns UpdateRequestCreateResponse|errorCreate an Update Request
Parameters
- payload UpdateRequest -
- headers UpdaterequestsCreateHeaders (default {}) - Headers to be sent with the request
Return Type
- UpdateRequestCreateResponse|error - Result object containing the newly created UpdateRequest object
get sheets/[decimal sheetId]/updaterequests/[string updateRequestId]
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/updaterequests/[string updateRequestId](UpdaterequestsGetHeaders headers) returns UpdateRequest|errorGet an Update Request
Parameters
- headers UpdaterequestsGetHeaders (default {}) - Headers to be sent with the request
Return Type
- UpdateRequest|error - UpdateRequest object
put sheets/[decimal sheetId]/updaterequests/[string updateRequestId]
Isolated FunctionResource Function
function put sheets/[decimal sheetId]/updaterequests/[string updateRequestId](UpdaterequestsUpdateHeaders headers) returns UpdateRequestCreateResponse|errorUpdate an Update Request
Parameters
- headers UpdaterequestsUpdateHeaders (default {}) - Headers to be sent with the request
Return Type
- UpdateRequestCreateResponse|error - Result object containing the modified UpdateRequest object
delete sheets/[decimal sheetId]/updaterequests/[string updateRequestId]
Isolated FunctionResource Function
function delete sheets/[decimal sheetId]/updaterequests/[string updateRequestId](UpdaterequestsDeleteHeaders headers) returns Result|errorDelete an Update Request
Parameters
- headers UpdaterequestsDeleteHeaders (default {}) - Headers to be sent with the request
get sheets/[decimal sheetId]/shares
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/shares(ListSheetSharesHeaders headers, *ListSheetSharesQueries queries) returns PublicTemplateListResponse|errorList Sheet Shares
Parameters
- headers ListSheetSharesHeaders (default {}) - Headers to be sent with the request
- queries *ListSheetSharesQueries - Queries to be sent with the request
Return Type
- PublicTemplateListResponse|error - IndexResult object containing an array of Share objects. By default, this operation returns only item-level shares (scope=ITEM). Use the sharingInclude parameter to request that workspace-level shares (include=workspaceShares) also be returned
post sheets/[decimal sheetId]/shares
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/shares(SheetIdSharesBody payload, ShareSheetHeaders headers, *ShareSheetQueries queries) returns TokenResponse|errorShare Sheet
Parameters
- payload SheetIdSharesBody -
- headers ShareSheetHeaders (default {}) - Headers to be sent with the request
- queries *ShareSheetQueries - Queries to be sent with the request
Return Type
- TokenResponse|error - Result object containing either a single Share object or an array of Share objects, corresponding to what was specified in the request. All shares have scope=ITEM
get sheets/[decimal sheetId]/shares/[string shareId]
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/shares/[string shareId](ShareSheetGetHeaders headers, *ShareSheetGetQueries queries) returns Share|errorGet Sheet Share.
Parameters
- headers ShareSheetGetHeaders (default {}) - Headers to be sent with the request
- queries *ShareSheetGetQueries - Queries to be sent with the request
put sheets/[decimal sheetId]/shares/[string shareId]
Isolated FunctionResource Function
function put sheets/[decimal sheetId]/shares/[string shareId](SharesshareIdBody payload, UpdateSheetShareHeaders headers, *UpdateSheetShareQueries queries) returns UserResponse|errorUpdate Sheet Share.
Parameters
- payload SharesshareIdBody -
- headers UpdateSheetShareHeaders (default {}) - Headers to be sent with the request
- queries *UpdateSheetShareQueries - Queries to be sent with the request
Return Type
- UserResponse|error - Returns Result object containing the modified Share object
delete sheets/[decimal sheetId]/shares/[string shareId]
Isolated FunctionResource Function
function delete sheets/[decimal sheetId]/shares/[string shareId](DeleteSheetShareHeaders headers, *DeleteSheetShareQueries queries) returns Result|errorDelete Sheet Share
Parameters
- headers DeleteSheetShareHeaders (default {}) - Headers to be sent with the request
- queries *DeleteSheetShareQueries - Queries to be sent with the request
post sheets/[decimal sheetId]/sort
Isolated FunctionResource Function
function post sheets/[decimal sheetId]/sort(SortSpecifier payload, RowsSortHeaders headers, *RowsSortQueries queries) returns SheetResponse|errorSort Rows in Sheet
Parameters
- payload SortSpecifier - SortSpecifier with the following attribute:
- headers RowsSortHeaders (default {}) - Headers to be sent with the request
- queries *RowsSortQueries - Queries to be sent with the request
Return Type
- SheetResponse|error - Returns Sheet object, populated according to the specified parameters
get sheets/[decimal sheetId]/version
Isolated FunctionResource Function
function get sheets/[decimal sheetId]/version(GetSheetVersionHeaders headers) returns SheetVersion|errorGet Sheet Version
Parameters
- headers GetSheetVersionHeaders (default {}) - Headers to be sent with the request
Return Type
- SheetVersion|error - OK
get sights
Isolated FunctionResource Function
function get sights(ListSightsHeaders headers, *ListSightsQueries queries) returns DashboardListResponse|errorList Dashboards
Parameters
- headers ListSightsHeaders (default {}) - Headers to be sent with the request
- queries *ListSightsQueries - Queries to be sent with the request
Return Type
- DashboardListResponse|error - IndexResult object containing an array of Dashboard objects with a subset of attributes
get sights/[string sightId]
Isolated FunctionResource Function
function get sights/[string sightId](GetSightHeaders headers, *GetSightQueries queries) returns Sight|errorGet Dashboard
Parameters
- headers GetSightHeaders (default {}) - Headers to be sent with the request
- queries *GetSightQueries - Queries to be sent with the request
put sights/[string sightId]
Isolated FunctionResource Function
function put sights/[string sightId](SightName payload, UpdateSightHeaders headers, *UpdateSightQueries queries) returns ShareResponse|errorUpdate Dashboard
Parameters
- payload SightName -
- headers UpdateSightHeaders (default {}) - Headers to be sent with the request
- queries *UpdateSightQueries - Queries to be sent with the request
Return Type
- ShareResponse|error - Result object containing the updated Dashboard object
delete sights/[string sightId]
Isolated FunctionResource Function
function delete sights/[string sightId](DeleteSightHeaders headers) returns ProofCreateResponse|errorDelete Dashboard
Parameters
- headers DeleteSightHeaders (default {}) - Headers to be sent with the request
Return Type
- ProofCreateResponse|error - Generic response result
post sights/[string sightId]/copy
Isolated FunctionResource Function
function post sights/[string sightId]/copy(ContainerDestinationForCopy payload, CopySightHeaders headers) returns ShareCreateResponse|errorCopy Dashboard
Parameters
- payload ContainerDestinationForCopy -
- headers CopySightHeaders (default {}) - Headers to be sent with the request
Return Type
- ShareCreateResponse|error - Result object containing a dashboard with a subset of attributes for the newly created dashboard
post sights/[string sightId]/move
Isolated FunctionResource Function
function post sights/[string sightId]/move(ContainerDestinationForMove payload, MoveSightHeaders headers) returns ShareCreateResponse|errorMove Dashboard
Parameters
- payload ContainerDestinationForMove -
- headers MoveSightHeaders (default {}) - Headers to be sent with the request
Return Type
- ShareCreateResponse|error - Result object containing a Dashboard object with a subset of attributes for the moved dashboard
get sights/[string sightId]/publish
Isolated FunctionResource Function
function get sights/[string sightId]/publish(GetSightPublishStatusHeaders headers) returns SightPublish|errorGet Dashboard Publish Status
Parameters
- headers GetSightPublishStatusHeaders (default {}) - Headers to be sent with the request
Return Type
- SightPublish|error - SightPublish object
put sights/[string sightId]/publish
Isolated FunctionResource Function
function put sights/[string sightId]/publish(SightPublish payload, SetSightPublishStatusHeaders headers) returns ShareUpdateResponse|errorSet Dashboard Publish Status
Parameters
- payload SightPublish -
- headers SetSightPublishStatusHeaders (default {}) - Headers to be sent with the request
Return Type
- ShareUpdateResponse|error - SightPublish object
get sights/[string sightId]/shares
Isolated FunctionResource Function
function get sights/[string sightId]/shares(ListSightSharesHeaders headers, *ListSightSharesQueries queries) returns PublicTemplateListResponse|errorList Dashboard Shares
Parameters
- headers ListSightSharesHeaders (default {}) - Headers to be sent with the request
- queries *ListSightSharesQueries - Queries to be sent with the request
Return Type
- PublicTemplateListResponse|error - IndexResult object containing an array of Share objects. By default, this operation returns only item-level shares (scope=ITEM). Use the sharingInclude parameter to request that workspace-level shares (scope=WORKSPACE) also be returned
post sights/[string sightId]/shares
Isolated FunctionResource Function
function post sights/[string sightId]/shares(Share payload, ShareSightHeaders headers, *ShareSightQueries queries) returns TokenResponse|errorShare Dashboard
Parameters
- payload Share -
- headers ShareSightHeaders (default {}) - Headers to be sent with the request
- queries *ShareSightQueries - Queries to be sent with the request
Return Type
- TokenResponse|error - Result object containing either a single Share object or an array of Share objects, corresponding to what was specified in the request. All shares have scope=ITEM
get sights/[string sightId]/shares/[string shareId]
Isolated FunctionResource Function
function get sights/[string sightId]/shares/[string shareId](ShareSightGetHeaders headers, *ShareSightGetQueries queries) returns Share|errorGet Dashboard Share
Parameters
- headers ShareSightGetHeaders (default {}) - Headers to be sent with the request
- queries *ShareSightGetQueries - Queries to be sent with the request
put sights/[string sightId]/shares/[string shareId]
Isolated FunctionResource Function
function put sights/[string sightId]/shares/[string shareId](SharesshareIdBody payload, UpdateSightShareHeaders headers, *UpdateSightShareQueries queries) returns UserResponse|errorUpdate Dashboard Share
Parameters
- payload SharesshareIdBody -
- headers UpdateSightShareHeaders (default {}) - Headers to be sent with the request
- queries *UpdateSightShareQueries - Queries to be sent with the request
Return Type
- UserResponse|error - Returns Result object containing the modified Share object
delete sights/[string sightId]/shares/[string shareId]
Isolated FunctionResource Function
function delete sights/[string sightId]/shares/[string shareId](DeleteSightShareHeaders headers) returns Result|errorDelete Dashboard Share
Parameters
- headers DeleteSightShareHeaders (default {}) - Headers to be sent with the request
get templates
Isolated FunctionResource Function
function get templates(TemplatesListHeaders headers, *TemplatesListQueries queries) returns WorkspaceListResponse|errorList User-Created Templates
Parameters
- headers TemplatesListHeaders (default {}) - Headers to be sent with the request
- queries *TemplatesListQueries - Queries to be sent with the request
Return Type
- WorkspaceListResponse|error - SUCCESS
get templates/'public
Isolated FunctionResource Function
function get templates/'public(TemplatesListPublicHeaders headers, *TemplatesListPublicQueries queries) returns WorkspaceListResponse|errorList Public Templates
Parameters
- headers TemplatesListPublicHeaders (default {}) - Headers to be sent with the request
- queries *TemplatesListPublicQueries - Queries to be sent with the request
Return Type
- WorkspaceListResponse|error - SUCCESS
post token
Isolated FunctionResource Function
function post token(TokensGetOrRefreshHeaders headers, *TokensGetOrRefreshQueries queries) returns Token|errorGets or Refreshes an Access Token
Parameters
- headers TokensGetOrRefreshHeaders (default {}) - Headers to be sent with the request
- queries *TokensGetOrRefreshQueries - Queries to be sent with the request
delete token
Isolated FunctionResource Function
function delete token(TokensDeleteHeaders headers, *TokensDeleteQueries queries) returns Result|errorRevoke Access Token
Parameters
- headers TokensDeleteHeaders (default {}) - Headers to be sent with the request
- queries *TokensDeleteQueries - Queries to be sent with the request
get users
Isolated FunctionResource Function
function get users(ListUsersHeaders headers, *ListUsersQueries queries) returns UserListResponse|errorList Users
Parameters
- headers ListUsersHeaders (default {}) - Headers to be sent with the request
- queries *ListUsersQueries - Queries to be sent with the request
Return Type
- UserListResponse|error - IndexResult object containing an array of User objects
post users
Isolated FunctionResource Function
function post users(User payload, AddUserHeaders headers, *AddUserQueries queries) returns UserProfileResponse|errorAdd User
Parameters
- payload User - The User to be created
- headers AddUserHeaders (default {}) - Headers to be sent with the request
- queries *AddUserQueries - Queries to be sent with the request
Return Type
- UserProfileResponse|error - Result object containing the newly created User object
get users/me
Isolated FunctionResource Function
function get users/me(GetCurrentUserHeaders headers, *GetCurrentUserQueries queries) returns UserImgProfileResponse|errorGet Current User
Parameters
- headers GetCurrentUserHeaders (default {}) - Headers to be sent with the request
- queries *GetCurrentUserQueries - Queries to be sent with the request
Return Type
- UserImgProfileResponse|error - IndexResultUnknownPages object containing a UserProfile object
get users/sheets
Isolated FunctionResource Function
function get users/sheets(ListOrgSheetsHeaders headers, *ListOrgSheetsQueries queries) returns HomeContentsResponse|errorList Org Sheets
Parameters
- headers ListOrgSheetsHeaders (default {}) - Headers to be sent with the request
- queries *ListOrgSheetsQueries - Queries to be sent with the request
Return Type
- HomeContentsResponse|error - IndexResultUnknownPages object containing an array of Sheet objects, limited to the following attributes: * id * name * owner: empty string * ownerId: (static "0")
get users/[decimal userId]
Isolated FunctionResource Function
function get users/[decimal userId](GetUserHeaders headers) returns UserProfile|errorGet User
Parameters
- headers GetUserHeaders (default {}) - Headers to be sent with the request
Return Type
- UserProfile|error - Returns UserProfile object
put users/[decimal userId]
Isolated FunctionResource Function
function put users/[decimal userId](UserUpdate payload, UpdateUserHeaders headers) returns HomeFolderCreateResponse|errorUpdate User
Parameters
- payload UserUpdate - User object containing at least one of the following attributes:
- headers UpdateUserHeaders (default {}) - Headers to be sent with the request
Return Type
- HomeFolderCreateResponse|error - Result object containing the User object for the updated user
delete users/[decimal userId]
Isolated FunctionResource Function
function delete users/[decimal userId](RemoveUserHeaders headers, *RemoveUserQueries queries) returns GenericResult|errorRemove User
Parameters
- headers RemoveUserHeaders (default {}) - Headers to be sent with the request
- queries *RemoveUserQueries - Queries to be sent with the request
Return Type
- GenericResult|error - Returns Result object
get users/[decimal userId]/alternateemails
Isolated FunctionResource Function
function get users/[decimal userId]/alternateemails(ListAlternateEmailsHeaders headers) returns FolderListResponse|errorList Alternate Emails
Parameters
- headers ListAlternateEmailsHeaders (default {}) - Headers to be sent with the request
Return Type
- FolderListResponse|error - IndexResult object containing an array of AlternateEmail objects
post users/[decimal userId]/alternateemails
Isolated FunctionResource Function
function post users/[decimal userId]/alternateemails(UserIdAlternateemailsBody payload, AddAlternateEmailHeaders headers) returns FolderCreateResponse|errorAdd Alternate Emails
Parameters
- payload UserIdAlternateemailsBody -
- headers AddAlternateEmailHeaders (default {}) - Headers to be sent with the request
Return Type
- FolderCreateResponse|error - Result object containing an array of the newly created AlternateEmail objects
get users/[decimal userId]/alternateemails/[decimal alternateEmailId]
Isolated FunctionResource Function
function get users/[decimal userId]/alternateemails/[decimal alternateEmailId](GetAlternateEmailHeaders headers) returns AlternateEmail|errorGet Alternate Email
Parameters
- headers GetAlternateEmailHeaders (default {}) - Headers to be sent with the request
Return Type
- AlternateEmail|error - Returns AlternateEmail object
delete users/[decimal userId]/alternateemails/[decimal alternateEmailId]
Isolated FunctionResource Function
function delete users/[decimal userId]/alternateemails/[decimal alternateEmailId](DeleteAlternateEmailHeaders headers) returns GenericResult|errorDelete Alternate Email
Parameters
- headers DeleteAlternateEmailHeaders (default {}) - Headers to be sent with the request
Return Type
- GenericResult|error - Returns Result object
post users/[decimal userId]/alternateemails/[decimal alternateEmailId]/makeprimary
Isolated FunctionResource Function
function post users/[decimal userId]/alternateemails/[decimal alternateEmailId]/makeprimary(PromoteAlternateEmailHeaders headers) returns FolderCopyResponse|errorMake Alternate Email Primary
Parameters
- headers PromoteAlternateEmailHeaders (default {}) - Headers to be sent with the request
Return Type
- FolderCopyResponse|error - OK
post users/[decimal userId]/deactivate
Isolated FunctionResource Function
function post users/[decimal userId]/deactivate(DeactivateUserHeaders headers) returns GenericResult|errorDeactivate User
Parameters
- headers DeactivateUserHeaders (default {}) - Headers to be sent with the request
Return Type
- GenericResult|error - Returns Result object
post users/[decimal userId]/profileimage
Isolated FunctionResource Function
function post users/[decimal userId]/profileimage(byte[] payload, UpdateUserProfileImageHeaders headers) returns HomeFolderCreateResponse|errorUpdate User Profile Image
Parameters
- payload byte[] -
- headers UpdateUserProfileImageHeaders (default {}) - Headers to be sent with the request
Return Type
- HomeFolderCreateResponse|error - Returns Result object
post users/[decimal userId]/reactivate
Isolated FunctionResource Function
function post users/[decimal userId]/reactivate(ReactivateUserHeaders headers) returns GenericResult|errorReactivate User
Parameters
- headers ReactivateUserHeaders (default {}) - Headers to be sent with the request
Return Type
- GenericResult|error - Returns Result object
get webhooks
Isolated FunctionResource Function
function get webhooks(ListWebhooksHeaders headers, *ListWebhooksQueries queries) returns WorkspaceFolderListResponse|errorList Webhooks
Parameters
- headers ListWebhooksHeaders (default {}) - Headers to be sent with the request
- queries *ListWebhooksQueries - Queries to be sent with the request
Return Type
- WorkspaceFolderListResponse|error - The List of Webhooks
post webhooks
Isolated FunctionResource Function
function post webhooks(WebhooksBody payload, CreateWebhookHeaders headers) returns WorkspaceFolderCreateResponse|errorCreate Webhook
Parameters
- payload WebhooksBody -
- headers CreateWebhookHeaders (default {}) - Headers to be sent with the request
Return Type
- WorkspaceFolderCreateResponse|error - Result object, containing a Webhook object for the newly created webhook
get webhooks/[string webhookId]
Isolated FunctionResource Function
function get webhooks/[string webhookId](GetWebhookHeaders headers) returns Webhook|errorGet Webhook
Parameters
- headers GetWebhookHeaders (default {}) - Headers to be sent with the request
put webhooks/[string webhookId]
Isolated FunctionResource Function
function put webhooks/[string webhookId](UpdateWebhookRequest payload, UpdateWebhookHeaders headers) returns WorkspaceFolderCreateResponse|errorUpdate Webhook
Parameters
- payload UpdateWebhookRequest -
- headers UpdateWebhookHeaders (default {}) - Headers to be sent with the request
Return Type
- WorkspaceFolderCreateResponse|error - Result object containing the Webhook object for the updated webhook
delete webhooks/[string webhookId]
Isolated FunctionResource Function
function delete webhooks/[string webhookId](DeleteWebhookHeaders headers) returns WorkspaceShareDeleteResponse|errorDelete Webhook
Parameters
- headers DeleteWebhookHeaders (default {}) - Headers to be sent with the request
Return Type
- WorkspaceShareDeleteResponse|error - Result object
post webhooks/[string webhookId]/resetSharedSecret
Isolated FunctionResource Function
function post webhooks/[string webhookId]/resetSharedSecret(ResetSharedSecretHeaders headers) returns WorkspaceShareCreateResponse|errorReset Shared Secret
Parameters
- headers ResetSharedSecretHeaders (default {}) - Headers to be sent with the request
Return Type
get workspaces
Isolated FunctionResource Function
function get workspaces(ListWorkspacesHeaders headers, *ListWorkspacesQueries queries) returns WorkspaceShareListResponse|errorList Workspaces
Parameters
- headers ListWorkspacesHeaders (default {}) - Headers to be sent with the request
- queries *ListWorkspacesQueries - Queries to be sent with the request
Return Type
- WorkspaceShareListResponse|error - IndexResult object containing an array of Workspace objects
post workspaces
Isolated FunctionResource Function
function post workspaces(WorkspacesBody payload, CreateWorkspaceHeaders headers, *CreateWorkspaceQueries queries) returns WorkspaceResponse|errorCreate Workspace
Parameters
- payload WorkspacesBody - Workspace to create
- headers CreateWorkspaceHeaders (default {}) - Headers to be sent with the request
- queries *CreateWorkspaceQueries - Queries to be sent with the request
Return Type
- WorkspaceResponse|error - Result object containing a Workspace object for newly created workspace
get workspaces/[string workspaceId]
Isolated FunctionResource Function
function get workspaces/[string workspaceId](GetWorkspaceHeaders headers, *GetWorkspaceQueries queries) returns Workspace|errorGet Workspace
Parameters
- headers GetWorkspaceHeaders (default {}) - Headers to be sent with the request
- queries *GetWorkspaceQueries - Queries to be sent with the request
put workspaces/[string workspaceId]
Isolated FunctionResource Function
function put workspaces/[string workspaceId](WorkspacesworkspaceIdBody payload, UpdateWorkspaceHeaders headers, *UpdateWorkspaceQueries queries) returns WorkspaceCreateResponse|errorUpdate Workspace
Parameters
- payload WorkspacesworkspaceIdBody -
- headers UpdateWorkspaceHeaders (default {}) - Headers to be sent with the request
- queries *UpdateWorkspaceQueries - Queries to be sent with the request
Return Type
- WorkspaceCreateResponse|error - Result object containing the modified Workspace object
delete workspaces/[string workspaceId]
Isolated FunctionResource Function
function delete workspaces/[string workspaceId](DeleteWorkspaceHeaders headers) returns GenericResult|errorDelete Workspace
Parameters
- headers DeleteWorkspaceHeaders (default {}) - Headers to be sent with the request
Return Type
- GenericResult|error - Returns Result object
post workspaces/[string workspaceId]/copy
Isolated FunctionResource Function
function post workspaces/[string workspaceId]/copy(WorkspaceIdCopyBody payload, CopyWorkspaceHeaders headers, *CopyWorkspaceQueries queries) returns ContainerDestinationForCopy|errorCopy Workspace
Parameters
- payload WorkspaceIdCopyBody - New workspace name
- headers CopyWorkspaceHeaders (default {}) - Headers to be sent with the request
- queries *CopyWorkspaceQueries - Queries to be sent with the request
Return Type
- ContainerDestinationForCopy|error - Result object containing a Workspace object for the new workspace destination
get workspaces/[string workspaceId]/folders
Isolated FunctionResource Function
function get workspaces/[string workspaceId]/folders(GetWorkspaceFoldersHeaders headers, *GetWorkspaceFoldersQueries queries) returns FolderContentsResponse|errorList Workspace Folders
Parameters
- headers GetWorkspaceFoldersHeaders (default {}) - Headers to be sent with the request
- queries *GetWorkspaceFoldersQueries - Queries to be sent with the request
Return Type
- FolderContentsResponse|error - An array of Folder references
post workspaces/[string workspaceId]/folders
Isolated FunctionResource Function
function post workspaces/[string workspaceId]/folders(FolderNameOnly payload, CreateWorkspaceFolderHeaders headers) returns CellHistoryResponse|errorCreate a Folder
Parameters
- payload FolderNameOnly - Folder to create
- headers CreateWorkspaceFolderHeaders (default {}) - Headers to be sent with the request
Return Type
- CellHistoryResponse|error - Result object containing a Folder object for newly created folder
get workspaces/[string workspaceId]/shares
Isolated FunctionResource Function
function get workspaces/[string workspaceId]/shares(ListWorkspaceSharesHeaders headers, *ListWorkspaceSharesQueries queries) returns PublicTemplateListResponse|errorList Workspace Shares
Parameters
- headers ListWorkspaceSharesHeaders (default {}) - Headers to be sent with the request
- queries *ListWorkspaceSharesQueries - Queries to be sent with the request
Return Type
- PublicTemplateListResponse|error - IndexResult object containing an array of Share objects
post workspaces/[string workspaceId]/shares
Isolated FunctionResource Function
function post workspaces/[string workspaceId]/shares(WorkspaceIdSharesBody payload, ShareWorkspaceHeaders headers, *ShareWorkspaceQueries queries) returns TokenResponse|errorShare Workspace
Parameters
- payload WorkspaceIdSharesBody -
- headers ShareWorkspaceHeaders (default {}) - Headers to be sent with the request
- queries *ShareWorkspaceQueries - Queries to be sent with the request
Return Type
- TokenResponse|error - This operation supports both single-object and bulk semantics. For more information, see Optional Bulk Operations
get workspaces/[string workspaceId]/shares/[string shareId]
Isolated FunctionResource Function
function get workspaces/[string workspaceId]/shares/[string shareId](ShareWorkspaceGetHeaders headers, *ShareWorkspaceGetQueries queries) returns Share|errorGet Workspace Share
Parameters
- headers ShareWorkspaceGetHeaders (default {}) - Headers to be sent with the request
- queries *ShareWorkspaceGetQueries - Queries to be sent with the request
put workspaces/[string workspaceId]/shares/[string shareId]
Isolated FunctionResource Function
function put workspaces/[string workspaceId]/shares/[string shareId](SharesshareIdBody payload, UpdateWorkspaceShareHeaders headers, *UpdateWorkspaceShareQueries queries) returns UserResponse|errorUpdate Workspace Share
Parameters
- payload SharesshareIdBody -
- headers UpdateWorkspaceShareHeaders (default {}) - Headers to be sent with the request
- queries *UpdateWorkspaceShareQueries - Queries to be sent with the request
Return Type
- UserResponse|error - Result object containing the modified Share object
delete workspaces/[string workspaceId]/shares/[string shareId]
Isolated FunctionResource Function
function delete workspaces/[string workspaceId]/shares/[string shareId](DeleteWorkspaceShareHeaders headers) returns Result|errorDelete Workspace Share
Parameters
- headers DeleteWorkspaceShareHeaders (default {}) - Headers to be sent with the request
post workspaces/[string workspaceId]/sheets
Isolated FunctionResource Function
function post workspaces/[string workspaceId]/sheets(WorkspaceIdSheetsBody payload, CreateSheetInWorkspaceHeaders headers, *CreateSheetInWorkspaceQueries queries) returns WebhookResponse|errorCreate Sheet in Workspace
Parameters
- payload WorkspaceIdSheetsBody - Sheet to create
- headers CreateSheetInWorkspaceHeaders (default {}) - Headers to be sent with the request
- queries *CreateSheetInWorkspaceQueries - Queries to be sent with the request
Return Type
- WebhookResponse|error - Result object containing a Sheet object for newly created sheet, corresponding to what was specified in the request
post workspaces/[string workspaceId]/sheets/'import
Isolated FunctionResource Function
function post workspaces/[string workspaceId]/sheets/'import(ImportSheetIntoWorkspaceHeaders headers, byte[] payload, *ImportSheetIntoWorkspaceQueries queries) returns WebhookListResponse|errorImport Sheet into Workspace
Parameters
- headers ImportSheetIntoWorkspaceHeaders - Headers to be sent with the request
- payload byte[] - Binary content for the CSV / XLSX file
- queries *ImportSheetIntoWorkspaceQueries - Queries to be sent with the request
Return Type
- WebhookListResponse|error - Result object containing a Sheet object for imported sheet
Records
smartsheet: AbstractDatetimeObjectValue
Fields
- value? string - Datetime, in the date-time format defined by <a href="https://tools.ietf.org/html/rfc3339#section-5.6" target="_blank" rel="noopener noreferrer">RFC 3339, section 5.6</a>
- objectType? "ABSTRACT_DATETIME" - Object representing a calculated datetime
smartsheet: AccesstokenAuthorize
Fields
- Fields Included from *Event
- action? "AUTHORIZE" - The action applied to the specified object
- additionalDetails? AccesstokenAuthorizeAdditionalDetails -
- objectType? "ACCESS_TOKEN" - The Smartsheet resource impacted by the event
smartsheet: AccesstokenAuthorizeAdditionalDetails
Fields
- tokenExpirationTimestamp? string - Date and time when this access token expires
- emailAddress string - Email address of the user responsible for the event
- appName? string - The name of the app to which this access token was granted. (Only included in cases when the access token was generated for an app)
- accessScopes? string - Comma-delimited list of access scopes granted to this access token. See these access scopes for details
- tokenName? string - Name of the newly created access token. (Only included in cases when a name was given to the token)
- tokenDisplayValue? string - Four or more characters used as a mnemonic to represent this access token. Even though this value serves as a visual token differentiator, this value isn't an Id because it isn't guaranteed to be unique across all tokens. This value is the same displayed by Smartsheet UI for each access token listed under Apps & Integrations > API Access
- appClientId? string - The client ID of the app to which this access token was granted. (Only included in cases when the access token was generated for an app)
smartsheet: AccesstokenRefresh
Fields
- Fields Included from *Event
- action? "REFRESH" - The action applied to the specified object
- additionalDetails? AccesstokenRefreshAdditionalDetails -
- objectType? "ACCESS_TOKEN" - The Smartsheet resource impacted by the event
smartsheet: AccesstokenRefreshAdditionalDetails
Fields
- tokenExpirationTimestamp? string - Date and time when this access token expires
- emailAddress string - Email address of the user responsible for the event
- tokenDisplayValue? string - Four or more characters used as a mnemonic to represent this access token. Even though this value serves as a visual token differentiator, this value isn't an Id because it isn't guaranteed to be unique across all tokens. This value is the same displayed by Smartsheet UI for each access token listed under Apps & Integrations > API Access
smartsheet: AccesstokenRevoke
Fields
- Fields Included from *Event
- action? "REVOKE" - The action applied to the specified object
- additionalDetails? AccesstokenRevokeAdditionalDetails -
- objectType? "ACCESS_TOKEN" - The Smartsheet resource impacted by the event
smartsheet: AccesstokenRevokeAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- tokenUserId? int - The ID of the user who owns this token
- tokenDisplayValue? string - Four or more characters used as a mnemonic to represent this access token. Even though this value serves as a visual token differentiator, this value isn't an Id because it isn't guaranteed to be unique across all tokens. This value is the same displayed by Smartsheet UI for each access token listed under Apps & Integrations > API Access
smartsheet: Account
Fields
- name? string - Account name
- id? decimal - Account Id
smartsheet: AccountBulkUpdate
Fields
- Fields Included from *Event
- action? "BULK_UPDATE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "ACCOUNT" - The Smartsheet resource impacted by the event
smartsheet: AccountBulkUpdateAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
smartsheet: AccountDownloadLoginHistory
Fields
- Fields Included from *Event
- action? "DOWNLOAD_LOGIN_HISTORY" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "ACCOUNT" - The Smartsheet resource impacted by the event
smartsheet: AccountDownloadPublishedItemsReport
Fields
- Fields Included from *Event
- action? "DOWNLOAD_PUBLISHED_ITEMS_REPORT" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "ACCOUNT" - The Smartsheet resource impacted by the event
smartsheet: AccountDownloadSheetAccessReport
Fields
- Fields Included from *Event
- action? "DOWNLOAD_SHEET_ACCESS_REPORT" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "ACCOUNT" - The Smartsheet resource impacted by the event
smartsheet: AccountDownloadUserList
Fields
- Fields Included from *Event
- action? "DOWNLOAD_USER_LIST" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "ACCOUNT" - The Smartsheet resource impacted by the event
smartsheet: AccountImportUsers
Fields
- Fields Included from *Event
- action? "IMPORT_USERS" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "ACCOUNT" - The Smartsheet resource impacted by the event
smartsheet: AccountListSheets
Fields
- Fields Included from *Event
- action? "LIST_SHEETS" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "ACCOUNT" - The Smartsheet resource impacted by the event
smartsheet: AccountRename
Fields
- Fields Included from *Event
- action? "RENAME" - The action applied to the specified object
- additionalDetails? AccountRenameAdditionalDetails -
- objectType? "ACCOUNT" - The Smartsheet resource impacted by the event
smartsheet: AccountRenameAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- newName? string - New name of the organization account
- oldName? string - Previous name of the organization account
smartsheet: AccountUpdateMainContact
Fields
- Fields Included from *Event
- action? "UPDATE_MAIN_CONTACT" - The action applied to the specified object
- additionalDetails? AccountUpdateMainContactAdditionalDetails -
- objectType? "ACCOUNT" - The Smartsheet resource impacted by the event
smartsheet: AccountUpdateMainContactAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- oldContactUserId? int - Id of the former main contact
- newContactUserId? int - Id of the new main contact
smartsheet: AddAlternateEmail
Fields
- email? string - User's alternate email address
smartsheet: AddAlternateEmailHeaders
Represents the Headers record for the operation: add-alternate-email
Fields
smartsheet: AddColumns
Fields
- options? string[] - Array of the options available for the column
- width? decimal - Display width of the column in pixels
- index? decimal - Column index or position. This number is zero-based
- id? decimal - Column Id
- title? string - Column title
- 'type? "ABSTRACT_DATETIME"|"CHECKBOX"|"CONTACT_LIST"|"DATE"|"DATETIME"|"DURATION"|"MULTI_CONTACT_LIST"|"MULTI_PICKLIST"|"PICKLIST"|"PREDECESSOR"|"TEXT_NUMBER" - See Column Types
- validation? boolean - Indicates whether validation has been enabled for the column (value = true)
smartsheet: AddCrosssheetReferenceHeaders
Represents the Headers record for the operation: add-crosssheet-reference
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: AddFavoriteHeaders
Represents the Headers record for the operation: add-favorite
Fields
- xSmarScActorId? string - UserId of the user
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: AddGroupHeaders
Represents the Headers record for the operation: add-group
Fields
smartsheet: AddGroupMembersHeaders
Represents the Headers record for the operation: add-group-members
Fields
smartsheet: AddImageSummaryFieldHeaders
Represents the Headers record for the operation: add-image-summaryField
Fields
- contentDisposition? string - Should be equal to "attachment" to tell the API that a file is in the body of the POST request, followed by a semicolon, followed by filename= and the URL-encoded filename in quotes
- contentLength? int - Must be set to the size of the file, in bytes. For example to determine file size using in UNIX: $ ls -l ProgressReport.docx 5463 ProgressReport.docx
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: AddImageSummaryFieldQueries
Represents the Queries record for the operation: add-image-summaryField
Fields
- altText? string - Url-encoded alternate text for the image
- overrideValidation boolean(default false) - You may use the query string parameter overrideValidation with a value of true to allow a cell value outside of the validation limits. You must specify strict with a value of false to bypass value type checking
smartsheet: AddImageToCellHeaders
Represents the Headers record for the operation: addImageToCell
Fields
- contentDisposition? string - Should be equal to "attachment" to tell the API that a file is in the body of the POST request, followed by a semicolon, followed by filename= and the URL-encoded filename in quotes
- contentLength? int - Must be set to the size of the file, in bytes. For example to determine file size using in UNIX: $ ls -l ProgressReport.docx 5463 ProgressReport.docx
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: AddImageToCellQueries
Represents the Queries record for the operation: addImageToCell
Fields
- altText? string - Url-encoded alternate text for the image
- overrideValidation boolean(default false) - You may use the query string parameter overrideValidation with a value of true to allow a cell value outside of the validation limits. You must specify strict with a value of false to bypass value type checking
smartsheet: AddRowsObject
Fields
- createdAt? Timestamp -
- expanded? boolean - Indicates whether the row is expanded or collapsed
- cells? CellObjectForRows[] - Cells objects
- modifiedAt? Timestamp -
- sheetId? decimal - Parent sheet Id
- id? decimal - Row Id
- rowNumber? decimal - Row number within the sheet
- version? decimal - Sheet version number that is incremented every time a sheet is modified
smartsheet: AddSummaryFieldsHeaders
Represents the Headers record for the operation: add-summary-fields
Fields
smartsheet: AddSummaryFieldsQueries
Represents the Queries record for the operation: add-summary-fields
Fields
- renameIfConflict boolean(default false) - Set to true if you want to override the requirement for unique summary field names. Repeated names will be adjusted by appending "(1)" or similar after the field name
smartsheet: AddUserHeaders
Represents the Headers record for the operation: add-user
Fields
smartsheet: AddUserQueries
Represents the Queries record for the operation: add-user
Fields
- sendEmail boolean(default false) - Either true or false to indicate whether to notify the user by email. Default is false. If true, limit is 1000 emails
smartsheet: AlternateEmail
Fields
- id? decimal - AlternateEmail Id
- confirmed? boolean - Indicates whether the alternate email address has been confirmed
- email? string - User's alternate email address
smartsheet: AlternateEmailData
Fields
- result? SearchResultItem[] -
smartsheet: AlternateEmailListData
Fields
- data? SchemasSheet[] -
smartsheet: AlternateEmailListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *AlternateEmailListData
- data SchemasSheet[]
- anydata...
smartsheet: AlternateEmailResponse
Fields
- Fields Included from *SearchResult
- results SearchResultItem[]
- totalCount decimal
- anydata...
- Fields Included from *AlternateEmailData
- result SearchResultItem[]
- anydata...
smartsheet: Attachment
Attachment Object
Fields
- createdAt? Timestamp - Attachment creation date and time
- attachmentSubType? "DOCUMENT"|"DRAWING"|"FOLDER"|"PDF"|"PRESENTATION"|"SPREADSHEET" - Attachment sub type. Note--Folder type is for EGNYTE values and the rest are GOOGLE_DRIVE values
- attachmentType? "BOX_COM"|"DROPBOX"|"EGNYTE"|"EVERNOTE"|"FILE"|"GOOGLE_DRIVE"|"LINK"|"ONEDRIVE"|"TRELLO" - Attachment type. Note--Dropbox, Egnyte, and Evernote are not supported for Smartsheet.gov accounts
- createdBy? MiniUser -
Userobject containingnameandemailof the user who created this attachment
- urlExpiresInMillis? decimal - Attachment temporary URL time to live (files only)
- name? string - Attachment name
- id? decimal - Attachment Id
- mimeType? string - Attachment MIME type
- sizeInKb? decimal - The size of the file, if the attachmentType is FILE
- parentId? decimal - The Id of the parent
- parentType? "COMMENT"|"PROOF"|"ROW"|"SHEET" - The type of object the attachment belongs to
- url? string - Attachment temporary URL (files only)
smartsheet: AttachmentCreate
Fields
- Fields Included from *Event
- action? "CREATE" - The action applied to the specified object
- additionalDetails? AttachmentCreateAdditionalDetails -
- objectType? "ATTACHMENT" - The Smartsheet resource impacted by the event
smartsheet: AttachmentCreateAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- sheetId? int - Id of the sheet that contains the attachment. (This property is included only if the
workspaceIdproperty below isn't included)
- attachmentName? string - Name of the attachment
- workspaceId? int - Id of the workspace that directly contains the attachment. (This property is included only if the
sheetIdproperty above isn't included)
smartsheet: AttachmentDelete
Fields
- Fields Included from *Event
- action? "DELETE" - The action applied to the specified object
- additionalDetails? AttachmentDeleteAdditionalDetails -
- objectType? "ATTACHMENT" - The Smartsheet resource impacted by the event
smartsheet: AttachmentDeleteAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- sheetId? int - Id of the sheet that contains the attachment. (This property is included only if the
workspaceIdproperty below isn't included)
- workspaceId? int - Id of the workspace that directly contains the attachment. (This property is included only if the
sheetIdproperty above isn't included)
smartsheet: AttachmentListData
Fields
- result? Sheet -
smartsheet: AttachmentListResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *AttachmentListData
- result Sheet
- anydata...
smartsheet: AttachmentLoad
Fields
- Fields Included from *Event
- action? "LOAD" - The action applied to the specified object
- additionalDetails? AttachmentLoadAdditionalDetails -
- objectType? "ATTACHMENT" - The Smartsheet resource impacted by the event
smartsheet: AttachmentLoadAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- sheetId? int - Id of the sheet that contains the attachment. (This property is included only if the
workspaceIdproperty below isn't included)
- multiFileDownloadName? string - Name of the compressed file containing the multiple attachments downloaded at once. (Only included if more than one attachment was selected to be downloaded in the same user action. Please notice that multi-attachment download action allows the user to specify the name of the zip file that shoud include all attachments, which is what is being provided here. The download of a single attachment uses the attachment name as the download file name and it cannot be changed, and it isn't provided in this event because it is provided in the ATTACHMENT-CREATE event or by querying Smartsheet API with the attachment ID)
- workspaceId? int - Id of the workspace that directly contains the attachment. (This property is included only if the
sheetIdproperty above isn't included)
smartsheet: AttachmentsAttachToCommentHeaders
Represents the Headers record for the operation: attachments-attachToComment
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: AttachmentsAttachToSheetHeaders
Represents the Headers record for the operation: attachments-attachToSheet
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: AttachmentsDeleteHeaders
Represents the Headers record for the operation: attachments-delete
Fields
smartsheet: AttachmentSend
Fields
- Fields Included from *Event
- action? "SEND" - The action applied to the specified object
- additionalDetails? AttachmentSendAdditionalDetails -
- objectType? "ATTACHMENT" - The Smartsheet resource impacted by the event
smartsheet: AttachmentSendAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- sheetId? int - Id of the sheet that contains the attachment. (This property is included only if the
workspaceIdproperty below isn't included)
- recipientGroupId? int - Single ID of a user group explicitly included in the recipient list. (This property is included only if the
recipientEmailproperty above isn't included)
- recipientEmail? string - Single email address either of a user explicitly included in the recipient list or of the sender (when CC sender is requested). (This property is included only if the recipientGroupId property below isn't included)
- workspaceId? int - Id of the workspace that directly contains the attachment. (This property is included only if the
sheetIdproperty above isn't included)
smartsheet: AttachmentsGetHeaders
Represents the Headers record for the operation: attachments-get
Fields
smartsheet: AttachmentsListOnRowHeaders
Represents the Headers record for the operation: attachments-listOnRow
Fields
smartsheet: AttachmentsListOnRowQueries
Represents the Queries record for the operation: attachments-listOnRow
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: AttachmentsListOnSheetHeaders
Represents the Headers record for the operation: attachments-listOnSheet
Fields
smartsheet: AttachmentsListOnSheetQueries
Represents the Queries record for the operation: attachments-listOnSheet
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: AttachmentsVersionListHeaders
Represents the Headers record for the operation: attachments-versionList
Fields
smartsheet: AttachmentsVersionListQueries
Represents the Queries record for the operation: attachments-versionList
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: AttachmentsVersionsDeleteHeaders
Represents the Headers record for the operation: attachments-versionsDelete
Fields
smartsheet: AttachmentsVersionUploadHeaders
Represents the Headers record for the operation: attachments-versionUpload
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: AttachmentUpdate
Fields
- Fields Included from *Event
- action? "UPDATE" - The action applied to the specified object
- additionalDetails? AttachmentDeleteAdditionalDetails -
- objectType? "ATTACHMENT" - The Smartsheet resource impacted by the event
smartsheet: AttachmentVersionListData
Fields
- data? Attachment[] - list of attachments
smartsheet: AttachmentVersionListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *AttachmentVersionListData
- data Attachment[]
- anydata...
smartsheet: AttachmentVersionResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- result? Attachment - Attachment Object
smartsheet: AutomationRule
Fields
- createdAt? Timestamp - A timestamp of when the rule was originally added
- disabledReason? "APPROVAL_COLUMN_MISSING"|"APPROVAL_COLUMN_WRONG_TYPE"|"AUTOMATION_NOT_ENABLED_FOR_ORG"|"COLUMN_MISSING"|"COLUMN_TYPE_INCOMPATIBLE"|"NO_POTENTIAL_RECIPIENTS"|"NO_VALID_SELECTED_COLUMNS" - Machine-readable reason a rule is disabled:
-
APPROVAL_COLUMN_MISSINGThis rule's approval status column has been deleted. -
APPROVAL_COLUMN_WRONG_TYPEThe approval column must be a dropdown column. -
AUTOMATION_NOT_ENABLED_FOR_ORGTo create or edit automated actions, you need to upgrade your organization account to a Business or Enterprise plan. -
COLUMN_MISSINGA column referenced by this rule has been deleted. -
COLUMN_TYPE_INCOMPATIBLEA column referenced by this rule has been changed to an incompatible column type. -
NO_POTENTIAL_RECIPIENTSThis rule has no recipients that will be able to receive notifications based on this sheet's permission settings or this account's approved domain sharing list. -
NO_VALID_SELECTED_COLUMNSAll selected columns for this rule have been deleted
-
- createdBy? MiniUser -
Userobject containingnameandemailof the creator of this rule
- modifiedAt? Timestamp - The datetime for when the change was made to the rule
- name? string - Rule name as shown in the UI
- userCanModify? boolean - If true, indicates that the current user can modify the rule
- action? anydata - An AutomationAction object containing information for this rule, such as type, recipients, and frequency
- modifiedBy? MiniUser -
Userobject containing thenameandemailof the user that made the change
- id? decimal - AutomationRule Id
- disabledReasonText? string - Descriptive reason a rule is disabled
- enabled? boolean - If true, indicates that the rule is active
smartsheet: AutomationruleDeleteHeaders
Represents the Headers record for the operation: automationrule-delete
Fields
smartsheet: AutomationruleGetHeaders
Represents the Headers record for the operation: automationrule-get
Fields
smartsheet: AutomationRuleListData
Fields
- data? AutomationRule[] - list of Automation Rules
smartsheet: AutomationRuleListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *AutomationRuleListData
- data AutomationRule[]
- anydata...
smartsheet: AutomationrulesListHeaders
Represents the Headers record for the operation: automationrules-list
Fields
smartsheet: AutomationrulesListQueries
Represents the Queries record for the operation: automationrules-list
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: AutomationruleUpdateHeaders
Represents the Headers record for the operation: automationrule-update
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: AutomationRuleUpdateResponse
Fields
- Fields Included from *FavoriteData
- result AutomationRule
- anydata...
smartsheet: AutoNumberFormat
Object that describes how the the System Column type of "AUTO_NUMBER" is auto-generated
Fields
- prefix? string - The prefix. Can include the date tokens:
- {DD}
- {MM}
- {YY}
- {YYYY}
- startingNumber? decimal - The starting number for the auto-id
- fill? string - Indicates zero-padding. Must be between 0 and 10 "0" (zero) characters
- suffix? string - The suffix. Can include the date tokens:
- {DD}
- {MM}
- {YY}
- {YYYY}
smartsheet: Cell
Fields
- conditionalFormat? string - The format descriptor describing this cell's conditional format. Only returned if the include query string parameter contains format and this cell has a conditional format applied
- hyperlink? Hyperlink - Represents a hyperlink, which can be a URL or a link to a report, sheet, or dashboard
- image? Image - Represents an image object, including its unique ID, dimensions, and alternate text
- columnId? decimal - The Id of the column that the cell is located in
- format? string - The format descriptor. Only returned if the include query string parameter contains format and this cell has a non-default format applied
- objectValue? ObjectValue - The base object for values found in the Cell.objectValue attribute. Its objectType attribute indicates the type of the object. This object itself is not used directly
- overrideValidation? boolean - (Admin only) Indicates whether the cell value can contain a value outside of the validation limits (value = true). When using this parameter, you must also set strict to false to bypass value type checking. This property is honored for POST or PUT actions that update rows
- displayValue? string - Visual representation of cell contents, as presented to the user in the UI
- columnType? string - Only returned if the include query string parameter contains columnType
- formula? string - The formula for a cell, if set, for instance =COUNTM([Assigned To]3). Note that calculation errors or problems with a formula do not cause the API call to return an error code. Instead, the response contains the same value as in the UI, such as cell.value = "#CIRCULAR REFERENCE"
- strict? boolean - Set to false to enable lenient parsing. Defaults to true. You can specify this attribute in a request, but it is never present in a response
- linkInFromCell? CellLink -
- linksOutToCells? CellLink[] -
smartsheet: CellHistoryData
Fields
- result? FolderSimpleResponse - Can contain dashboards, folders, reports, sheets, or templates
smartsheet: CellHistoryGetHeaders
Represents the Headers record for the operation: cellHistory-get
Fields
smartsheet: CellHistoryGetQueries
Represents the Queries record for the operation: cellHistory-get
Fields
- include? "columnType"|"objectValue" - A comma-separated list of elements to copy:
- columnType - includes the columnType attribute for each Cell object
- objectValue - when used in combination with a level query parameter, includes the email addresses for a multi-contact cell
- level int(default 0) - Specifies whether object data types, such as multi-contact data are returned in a backwards-compatible, text format in text/number columns.<br> - Set
level=0(default) to use text/number columns for multi-contact data and multi-picklist data.<br> - Setlevel=1to use multiple-entry contact list columns for multi-contact data; multi-picklist data is returned in text/number columns.<br> - Setlevel=2to use multiple-entry contact list columns for multi-contact data and use multiple-entry picklist columns for multi-picklist data
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: CellHistoryResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *CellHistoryData
- result FolderSimpleResponse
- anydata...
smartsheet: CellLink
Fields
- sheetName? string - Sheet name of the linked cell
- columnId? decimal - Column Id of the linked cell
- sheetId? decimal - Sheet Id of the sheet that the linked cell belongs to
- rowId? decimal - Row Id of the linked cell
- status? "BLOCKED"|"BROKEN"|"CIRCULAR"|"DISABLED"|"INACCESSIBLE"|"INVALID"|"NOT_SHARED"|"OK" -
BLOCKEDOne of several other values indicating unusual error conditions.BROKENThe row or sheet linked to was deleted.CIRCULAROne of several other values indicating unusual error conditions.DISABLEDOne of several other values indicating unusual error conditions.INACCESSIBLEThe sheet linked to cannot be viewed by this user.INVALIDOne of several other values indicating unusual error conditions.NOT_SHAREDOne of several other values indicating unusual error conditions.OKThe link is in a good state
smartsheet: CellObjectForRows
Fields
- displayValue? string - Visual representation of cell contents, as presented to the user in the UI
- columnType? string - Only returned if the include query string parameter contains columnType
- columnId? decimal - The Id of the column that the cell is located in
smartsheet: CheckboxObjectValue
Object representing a checkbox
Fields
- value? boolean - true if checked; false otherwise
- objectType? "CHECKBOX" - Type of this object, always set to 'CHECKBOX'
smartsheet: Column
Fields
- symbol? string - When applicable for CHECKBOX or PICKLIST column types. See Symbol Columns
- contactOptions? ContactOption[] - Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST
- format? string - The format descriptor (see Cell formatting). Only returned if the include query string parameter contains format and this column has a non-default format applied to it
- description? string - Column description
- index? decimal - Column index or position. This number is zero-based
- title? string - Column title
- 'type? "ABSTRACT_DATETIME"|"CHECKBOX"|"CONTACT_LIST"|"DATE"|"DATETIME"|"DURATION"|"MULTI_CONTACT_LIST"|"MULTI_PICKLIST"|"PICKLIST"|"PREDECESSOR"|"TEXT_NUMBER" - See Column Types
- version? 0|1|2 -
0: CONTACT_LIST, PICKLIST, or TEXT_NUMBER.1: MULTI_CONTACT_LIST.2: MULTI_PICKLIST
- autoNumberFormat? AutoNumberFormat - Object that describes how the the System Column type of "AUTO_NUMBER" is auto-generated
- options? string[] - Array of the options available for the column
- width? decimal - Display width of the column in pixels
- formula? string - The formula for the column, if set
- lockedForUser? boolean - Indicates whether the column is locked for the requesting user. This attribute may be present in a response, but cannot be specified in a request
- systemColumnType? "AUTO_NUMBER"|"CREATED_BY"|"CREATED_DATE"|"MODIFIED_BY"|"MODIFIED_DATE" - See System Columns
- id? decimal - Column Id
- locked? boolean - Indicates whether the column is locked. In a response, a value of true indicates that the column has been locked by the sheet owner or the admin
- validation? boolean - Indicates whether validation has been enabled for the column (value = true)
- primary? boolean - Returned only if the column is the Primary Column (value = true)
smartsheet: ColumnCreateData
Fields
- result? AddColumns[] -
smartsheet: ColumnCreateResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *ColumnCreateData
- result AddColumns[]
- anydata...
smartsheet: ColumnDeleteHeaders
Represents the Headers record for the operation: column-delete
Fields
smartsheet: ColumnGetHeaders
Represents the Headers record for the operation: column-get
Fields
smartsheet: ColumnGetQueries
Represents the Queries record for the operation: column-get
Fields
- level int(default 0) - Specifies whether object data types, such as multi-contact data are returned in a backwards-compatible, text format in text/number columns.<br> - Set
level=0(default) to use text/number columns for multi-contact data and multi-picklist data.<br> - Setlevel=1to use multiple-entry contact list columns for multi-contact data; multi-picklist data is returned in text/number columns.<br> - Setlevel=2to use multiple-entry contact list columns for multi-contact data and use multiple-entry picklist columns for multi-picklist data
smartsheet: ColumnListData
Fields
- data? GetColumn[] -
smartsheet: ColumnListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *ColumnListData
- data GetColumn[]
- anydata...
smartsheet: ColumnObjectAttributes
Fields
- symbol? string - When applicable for CHECKBOX or PICKLIST column types. See Symbol Columns
- contactOptions? ContactOption -
- format? string - The format descriptor (see Cell formatting). Only returned if the include query string parameter contains format and this column has a non-default format applied to it
- index? decimal - Column index or position. This number is zero-based
- description? string - Column description
- title? string - Column title
- 'type? "ABSTRACT_DATETIME"|"CHECKBOX"|"CONTACT_LIST"|"DATE"|"DATETIME"|"DURATION"|"MULTI_CONTACT_LIST"|"MULTI_PICKLIST"|"PICKLIST"|"PREDECESSOR"|"TEXT_NUMBER" -
- version? decimal - Read only. The level of the column type. Each element in the array is set to one of the following values:
- 0: TEXT_NUMBER, CONTACT_LIST, or PICKLIST
- 1: MULTI_CONTACT_LIST
- 2: MULTI_PICKLIST
- autoNumberFormat? AutoNumberFormat - Object that describes how the the System Column type of "AUTO_NUMBER" is auto-generated
- options? string[] -
- width? decimal - Display width of the column in pixels
- formula? string - The formula for a column, if set, for instance =data@row
- lockedForUser? boolean - Indicates whether the column is locked for the requesting user. This attribute may be present in a response, but cannot be specified in a request
- systemColumnType? "AUTO_NUMBER"|"CREATED_BY"|"CREATED_DATE"|"MODIFIED_BY"|"MODIFIED_DATE" - See System Columns
- locked? boolean - Indicates whether the column is locked. In a response, a value of true indicates that the column has been locked by the sheet owner or the admin
- validation? boolean - Indicates whether validation has been enabled for the column (value = true)
smartsheet: ColumnsAddToSheetHeaders
Represents the Headers record for the operation: columns-addToSheet
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: ColumnsListOnSheetHeaders
Represents the Headers record for the operation: columns-listOnSheet
Fields
smartsheet: ColumnsListOnSheetQueries
Represents the Queries record for the operation: columns-listOnSheet
Fields
- level int(default 0) - Specifies whether object data types, such as multi-contact data are returned in a backwards-compatible, text format in text/number columns.<br> - Set
level=0(default) to use text/number columns for multi-contact data and multi-picklist data.<br> - Setlevel=1to use multiple-entry contact list columns for multi-contact data; multi-picklist data is returned in text/number columns.<br> - Setlevel=2to use multiple-entry contact list columns for multi-contact data and use multiple-entry picklist columns for multi-picklist data
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ColumnToCreateASheet
Fields
- symbol? Symbol - When applicable for CHECKBOX or PICKLIST column types. See Symbol Columns
- contactOptions? ContactOptions - Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST
- autoNumberFormat? AutoNumberFormat - Object that describes how the the System Column type of "AUTO_NUMBER" is auto-generated
- options? Options - Array of the options available for the column
- width? Width - Display width of the column in pixels
- systemColumnType? SystemColumnType - See System Columns
- title? Title - Column title
- 'type? Type - See Column Types
- primary? Primary - Returned only if the column is the Primary Column (value = true)
smartsheet: ColumnUpdateColumnHeaders
Represents the Headers record for the operation: column-updateColumn
Fields
smartsheet: ColumnUpdateData
Fields
- result? UpdateColumn -
smartsheet: ColumnUpdateResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *ColumnUpdateData
- result UpdateColumn
- anydata...
smartsheet: Comment
Fields
- createdAt? Timestamp -
- attachments? Attachment[] - Array of attachments on comments
- createdBy? MiniUser - User object containing name and email of the creator of this comment
- discussionId? decimal - Discussion Id of discussion that contains comment
- modifiedAt? Timestamp -
- id? decimal - Comment Id
- text? string - Comment body
smartsheet: CommentCreateResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- result? Comment -
smartsheet: CommentCreationRequest
Fields
- text? string - Comment body
smartsheet: CommentDeleteHeaders
Represents the Headers record for the operation: comment-delete
Fields
smartsheet: CommentEditHeaders
Represents the Headers record for the operation: comment-edit
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: CommentGetHeaders
Represents the Headers record for the operation: comment-get
Fields
smartsheet: CommentRequest
Comment
Fields
- text? string - Comment text
smartsheet: CommentsCreateHeaders
Represents the Headers record for the operation: comments-create
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: ComponentsSchemasSheet
Fields
- accessLevel? AccessLevel - Specifies the user's level of access or permissions, such as ADMIN, OWNER, EDITOR, or VIEWER
- name? Name - Sheet name
- id? Id - Sheet Id
- permalink? Permalink - URL that represents a direct link to the sheet in Smartsheet
smartsheet: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
smartsheet: Contact
Fields
- name? string - Contact's full name
- id? string - Contact Id
- email? string - Contact's email address
smartsheet: ContactData
Fields
- data? Favorite[] -
smartsheet: ContactListData
Fields
- data? Contact[] - List of Contacts
smartsheet: ContactListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *ContactListData
- data Contact[]
- anydata...
smartsheet: ContactObjectValue
Object containing a Contact
Fields
- imageId? string - ID of an image associated with the Contact
- name? string - Name of the Contact
- email? string - Email address of the Contact
- objectType? "CONTACT" - The type of this object, always set to 'CONTACT
smartsheet: ContactOption
Fields
- name? string - Can be a user's name, display name, or free text
- email? string - A parsable email address
smartsheet: ContactResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *ContactData
- data Favorite[]
- anydata...
smartsheet: ContainerDestinationForCopy
Fields
- newName? string - Name of the newly created object (when copying a dashboard, folder, sheet, or workspace)
- destinationType? "folder"|"home"|"workspace"? - Type of destination container.
The
"home"enum is Deprecated since March 25, 2025, and will be removed
- destinationId decimal - The ID of the destination container
smartsheet: ContainerDestinationForMove
Fields
- destinationType? "folder"|"home"|"workspace"? - Type of destination container.
The
"home"enum is Deprecated since March 25, 2025, and will be removed
- destinationId decimal - The ID of the destination container
smartsheet: CopyFolderHeaders
Represents the Headers record for the operation: copy-folder
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: CopyFolderQueries
Represents the Queries record for the operation: copy-folder
Fields
- include? "attachments"|"cellLinks"|"data"|"discussions"|"filters"|"forms"|"ruleRecipients"|"rules"|"shares" - A comma-separated list of elements to copy:
- attachments
- cellLinks - includes cross-sheet references
- data - includes formatting
- discussions - includes comments
- filters
- forms
- ruleRecipients -- includes notification recipients, must also include rules when using this attribute
- rules -- includes notifications and workflow rules
- shares | NOTE: Cell history is not copied, regardless of which include parameter values are specified
- skipRemap? "cellLinks"|"reports"|"sheetHyperlinks"|"sights" - A comma-separated list of references to NOT re-map for the newly created folder
- exclude? "sheetHyperlinks" - When specified with a value of sheetHyperlinks, excludes this category from the response
smartsheet: CopyOrMoveRowDestination
Fields
- sheetId? decimal - The Id of the destination sheet
smartsheet: CopyOrMoveRowDirective
Fields
- rowIds? decimal[] - The Ids of the rows to move or copy from the source sheet
- to? CopyOrMoveRowDestination -
smartsheet: CopyOrMoveRowResult
Fields
- destinationSheetId? decimal - The Id of the destination sheet
- rowMappings? RowMapping[] - Array of rowMapping objects
smartsheet: CopyRowsHeaders
Represents the Headers record for the operation: copy-rows
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: CopyRowsQueries
Represents the Queries record for the operation: copy-rows
Fields
- include? "all"|"attachments"|"children"|"discussions" - A comma-separated list of row elements to copy in addition to the cell data:
- all - specify a value of all to include everything (attachments, children, and discussions).
- attachments
- children - if specified, any child rows of the rows specified in the request are also copied to the destination sheet, and parent-child relationships amongst rows are preserved within the destination sheet; if not specified, only the rows specified in the request are copied.
- discussions
- ignoreRowsNotFound boolean(default false) - true or false: default is false. If set to true, specifying row Ids that do not exist within the source sheet does not cause an error response. If omitted or set to false, specifying row Ids that do not exist within the source sheet causes an error response (and no rows are copied)
smartsheet: CopySheetHeaders
Represents the Headers record for the operation: copy-sheet
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: CopySheetQueries
Represents the Queries record for the operation: copy-sheet
Fields
- include? "attachments"|"cellLinks"|"data"|"discussions"|"filters"|"forms"|"ruleRecipients"|"rules"|"shares" - A comma-separated list of elements to copy:
- attachments
- cellLinks - includes cross-sheet references
- data - includes formatting
- discussions - includes comments
- filters
- forms
- ruleRecipients -- includes notification recipients, must also include rules when using this attribute
- rules -- includes notifications and workflow rules
- shares | NOTE: Cell history is not copied, regardless of which include parameter values are specified
- exclude? "sheetHyperlinks" - When specified with a value of sheetHyperlinks, excludes this category from the response
smartsheet: CopySightHeaders
Represents the Headers record for the operation: copy-sight
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: CopyWorkspaceHeaders
Represents the Headers record for the operation: copy-workspace
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: CopyWorkspaceQueries
Represents the Queries record for the operation: copy-workspace
Fields
- include? "all"|"attachments"|"brand"|"cellLinks"|"data"|"discussions"|"filters"|"forms"|"ruleRecipients"|"rules"|"shares" - A comma-separated list of elements to include:
- all
- attachments
- brand
- cellLinks - includes cross-sheet references
- data - includes formatting
- discussions - includes comments
- filters
- forms
- ruleRecipients
- rules
- shares NOTE: Cell history is not copied, regardless of which include parameter values are specified
- skipRemap? "cellLinks"|"reports"|"sheetHyperlinks"|"sights" - A comma-separated list of references to NOT re-map for the newly created folder
smartsheet: CreateFolderFolderHeaders
Represents the Headers record for the operation: create-folder-folder
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: CreateFolderFolderQueries
Represents the Queries record for the operation: create-folder-folder
Fields
- include? "attachments"|"cellLinks"|"data"|"discussions"|"filters"|"forms"|"ruleRecipients"|"rules"|"shares" - A comma-separated list of elements to copy:
- attachments
- cellLinks - includes cross-sheet references
- data - includes formatting
- discussions - includes comments
- filters
- forms
- ruleRecipients -- includes notification recipients, must also include rules when using this attribute
- rules -- includes notifications and workflow rules
- shares | NOTE: Cell history is not copied, regardless of which include parameter values are specified
- skipRemap? "cellLinks"|"reports"|"sheetHyperlinks"|"sights" - A comma-separated list of references to NOT re-map for the newly created folder
- exclude? "sheetHyperlinks" - When specified with a value of sheetHyperlinks, excludes this category from the response
smartsheet: CreateHomeFolderHeaders
Represents the Headers record for the operation: create-home-folder
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: CreateSheetInFolderHeaders
Represents the Headers record for the operation: create-sheet-in-folder
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: CreateSheetInFolderQueries
Represents the Queries record for the operation: create-sheet-in-folder
Fields
- include? "attachments"|"cellLinks"|"data"|"discussions"|"filters"|"forms"|"ruleRecipients"|"rules" - Additional parameter to create a sheet from template. A comma-separated list of elements to copy from the template
smartsheet: CreateSheetInSheetsFolderHeaders
Represents the Headers record for the operation: create-sheet-in-sheets-folder
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: CreateSheetInSheetsFolderQueries
Represents the Queries record for the operation: create-sheet-in-sheets-folder
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- include? "attachments"|"cellLinks"|"data"|"discussions"|"filters"|"forms"|"ruleRecipients"|"rules" - Additional parameter to create a sheet from template. A comma-separated list of elements to copy from the template
smartsheet: CreateSheetInWorkspaceHeaders
Represents the Headers record for the operation: create-sheet-in-workspace
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: CreateSheetInWorkspaceQueries
Represents the Queries record for the operation: create-sheet-in-workspace
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- include? "attachments"|"cellLinks"|"data"|"discussions"|"filters"|"forms"|"ruleRecipients"|"rules" - Additional parameter to create a sheet from template. A comma-separated list of elements to copy from the template
smartsheet: CreateWebhookHeaders
Represents the Headers record for the operation: createWebhook
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: CreateWebhookRequest
Fields
- scopeObjectId? int - ID of the object to subscribed to. Specified when a webhook is created and cannot be changed
- scope? "sheet" - Scope of the subscription. Currently, the only supported value is "sheet". Specified when a webhook is created and cannot be changed
- name? string - Webhook name
- callbackUrl? string - HTTPS URL where callbacks are sent
- subscope? CreateWebhookRequestSubscope - Limits the webhook to monitor specific columns designated by an array of sheet column IDs.
- version? decimal - Webhook version. Currently, the only supported value is 1. This attribute is intended to ensure backward compatibility as new webhook functionality is released. For example, a webhook with a version of 1 is guaranteed to always be sent callback objects that are compatible with the version 1 release of webhooks
- events? string[] - Array of the events that are subscribed to. Currently, must be an array of size 1 that contains the string value '*.*' (asterisk period asterisk), which means "all objects" and "all events"
smartsheet: CreateWebhookRequestSubscope
Limits the webhook to monitor specific columns designated by an array of sheet column IDs.
Fields
- columnIds? int[] - Array of IDs of the sheet columns to monitor
smartsheet: CreateWorkspaceFolderHeaders
Represents the Headers record for the operation: create-workspace-folder
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: CreateWorkspaceHeaders
Represents the Headers record for the operation: create-workspace
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: CreateWorkspaceQueries
Represents the Queries record for the operation: create-workspace
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- include? "all"|"attachments"|"brand"|"cellLinks"|"data"|"discussions"|"filters"|"forms"|"ruleRecipients"|"rules"|"shares" - A comma-separated list of elements to include:
- all
- attachments
- brand
- cellLinks - includes cross-sheet references
- data - includes formatting
- discussions - includes comments
- filters
- forms
- ruleRecipients
- rules
- shares NOTE: Cell history is not copied, regardless of which include parameter values are specified
- skipRemap? "cellLinks"|"reports"|"sheetHyperlinks"|"sights" - A comma-separated list of references to NOT re-map for the newly created folder
smartsheet: CrossSheetReference
Fields
- startRowId? decimal - Defines beginning edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters
- name? string - Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References
- startColumnId? decimal - Defines beginning edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters
- sourceSheetId? decimal - Sheet Id of source sheet
- endColumnId? decimal - Defines ending edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters
- endRowId? decimal - Defines ending edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters
- id? decimal - Cross-sheet reference Id, guaranteed unique within referencing sheet
- status? "BLOCKED"|"BROKEN"|"CIRCULAR"|"DISABLED"|"INVALID/UNKNOWN"|"NOT-SHARED"|"OK" - Status of request:
- 'BLOCKED' - A reference is downstream of a circular issue.
- 'BROKEN' - The data source location (column, row or sheet) was deleted.
- 'CIRCULAR' - The formula reference is self referencing and cannot be resolved.
- 'DISABLED' - Updating the reference is temporarily disabled due to maintenance.
- 'INVALID/UNKNOWN' - The reference is new and had not been validated.
- 'NOT_SHARED' - No common shared users.
- 'OK' - The reference is in a good state
smartsheet: CrossSheetReferenceCreateData
Fields
- data? CrossSheetReference[] -
smartsheet: CrossSheetReferenceCreateResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *CrossSheetReferenceCreateData
- data CrossSheetReference[]
- anydata...
smartsheet: CrossSheetReferenceData
Fields
- result? Folder - Can contain dashboards, folders, reports, sheets, or templates
smartsheet: CrossSheetReferenceListData
Fields
- result? ComponentsSchemasSheet -
smartsheet: CrossSheetReferenceListResponse
Fields
- Fields Included from *CrossSheetReferenceListData
- result ComponentsSchemasSheet
- anydata...
smartsheet: CrossSheetReferenceRequestWithColumnAndRowIds
CrossSheetReference object to create with specified cell range
Fields
- startRowId? decimal - Defines beginning edge of range when specifying one or more rows. Must be used with endRowId. To specify an entire row, omit the startColumnId and endColumnId parameters
- name? string - Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References
- startColumnId? decimal - Defines beginning edge of range when specifying one or more columns. Must be used with endColumnId. To specify an entire column, omit the startRowId and endRowId parameters
- sourceSheetId? decimal - Sheet Id of source sheet
- endColumnId? decimal - Defines ending edge of range when specifying one or more columns. Must be used with startColumnId. To specify an entire column, omit the startRowId and endRowId parameters
- endRowId? decimal - Defines ending edge of range when specifying one or more rows. Must be used with startRowId. To specify an entire row, omit the startColumnId and endColumnId parameters
smartsheet: CrossSheetReferenceRequestWithColumnIds
CrossSheetReference object to create which will refer to the entire columns in the range from startColumnId to endColumnId
Fields
- name? string - Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References
- startColumnId? decimal - Defines beginning edge of range when specifying one or more columns. Must be used with endColumnId
- sourceSheetId? decimal - Sheet Id of source sheet
- endColumnId? decimal - Defines ending edge of range when specifying one or more columns. Must be used with startColumnId
smartsheet: CrossSheetReferenceRequestWithRowIds
CrossSheetReference object to create which will refer to the entire rows in the range from startRowId to endRowId
Fields
- startRowId? decimal - Defines beginning edge of range when specifying one or more rows. Must be used with endRowId
- name? string - Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References
- sourceSheetId? decimal - Sheet Id of source sheet
- endRowId? decimal - Defines ending edge of range when specifying one or more rows. Must be used with startRowId
smartsheet: CrossSheetReferenceResponse
Fields
- Fields Included from *CrossSheetReferenceData
- result Folder
- anydata...
smartsheet: Currency
Fields
- symbol? string - The currency symbol
- code? string - The ISO 4217 currency code
smartsheet: DashboardAddPublish
Fields
- Fields Included from *Event
- action? "ADD_PUBLISH" - The action applied to the specified object
- additionalDetails? DashboardAddPublishAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardAddPublishAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- accessibleBy? "ALL"|"ORG" - Indicates who can use the link to view the dashboard:
"ALL"(accessible to any person with the link),"ORG"(accessible only by those belonging to the org)
- publishType? "read_only" - Indicates permissions granted to users with a valid link. All dashboard publishes are read only:
"read_only"
- publishFormat? "FULL" - Indicates format of the published dashboard. Dashboards are published in a rich media format:
"FULL",
smartsheet: DashboardAddShare
Fields
- Fields Included from *Event
- action? "ADD_SHARE" - The action applied to the specified object
- additionalDetails? DashboardAddShareAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardAddShareAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- accessLevel? "VIEWER"|"EDITOR"|"EDITOR_SHARE"|"ADMIN" - Indicates the access level granted to the user. Note that this access level represents the access level that has been granted to the user via group membership; it is not the user's effective access level for the dashboard
- groupId? int - Id of the group the user was added to
- userId? int - Id of the user that was added to the group
- workspaceId? int - Id of the workspace that the group is shared to. (Specific to cases where the dashboard is shared to the group via a workspace's sharing list)
smartsheet: DashboardAddShareMember
Fields
- Fields Included from *Event
- action? "ADD_SHARE_MEMBER" - The action applied to the specified object
- additionalDetails? DashboardAddShareMemberAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardAddShareMemberAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- accessLevel? "VIEWER"|"EDITOR"|"EDITOR_SHARE"|"ADMIN" - Indicates the access level granted to the group or user. Note that this access level represents the access level granted by this specific sharing action; it is not the group or user's effective access level for the dashboard
- groupId? int - Id of the group that was added to the dashboard's sharing list. (Specific to share to group actions)
- userId? int - Id of the user that was added to the dashboard's sharing list. (Specific to share to user actions)
smartsheet: DashboardAddWorkspaceShare
Fields
- Fields Included from *Event
- action? "ADD_WORKSPACE_SHARE" - The action applied to the specified object
- additionalDetails? DashboardAddWorkspaceShareAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardAddWorkspaceShareAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- accessLevel? "VIEWER"|"EDITOR"|"EDITOR_SHARE"|"ADMIN" - Indicates the access level granted to the group or user. Note that this access level represents the access level granted by this specific sharing action; it is not the group or user's effective access level for the dashboard
- groupId? int - Id of the group that the workspace was shared to. (Specific to share to group actions)
- userId? int - Id of the user that the workspace was shared to. (Specific to share to user actions)
- workspaceId? int - Id of the workspace that was shared to the group or user
smartsheet: DashboardCreate
Fields
- Fields Included from *Event
- action? "CREATE" -
- additionalDetails? DashboardCreateAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardCreateAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- sourceType? string - The source object used to create the dashboard, currently only 'global_template' is valid
- sourceGlobalTemplateId? int - Id of the global template that was used to create the dashboard. (Specific to
Create Newactions)
- sourceObjectId? int - Id of the source dashboard. (Specific to
Save As Newactions).
- dashboardName? string - Name of the newly created dashboard
smartsheet: DashboardDelete
Fields
- Fields Included from *Event
- action? "DELETE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardListData
Fields
- data? SightListItem[] - List of Dashboards
smartsheet: DashboardListing
Fields
- createdAt? Timestamp -
- modifiedAt? Timestamp -
- name? string - Asset name
- id? decimal - Asset Id
- permalink? string - URL that represents a direct link to the asset in Smartsheet
smartsheet: DashboardListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *DashboardListData
- data SightListItem[]
- anydata...
smartsheet: DashboardLoad
Fields
- Fields Included from *Event
- action? "LOAD" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardMove
Fields
- Fields Included from *Event
- action? "MOVE" - The action applied to the specified object
- additionalDetails? DashboardMoveAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardMoveAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- parentContainerId? int - Id of the parent container of the dashboard. (Specific to move events where a folder containing the dashboard is moved to a folder in a different workspace, indicates that the dashboard has moved to a new workspace but is still within the same folder)
- newParentContainerId? int - Id of the destination folder for the move event. (Specific to actions where the dashboard was moved to a different folder)
- folderName? string - Name of the destination folder for the move event. (Specific to actions where the dashboard was moved to a different folder)
- workspaceId? int - Id of the workspace the dashboard is currently in. If the move was between two workspaces the
workspaceIdwill be the Id of the destination workspace
smartsheet: DashboardPurge
Fields
- Fields Included from *Event
- action? "PURGE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardRemovePublish
Fields
- Fields Included from *Event
- action? "REMOVE_PUBLISH" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardRemoveShare
Fields
- Fields Included from *Event
- action? "REMOVE_SHARE" - The action applied to the specified object
- additionalDetails? DashboardRemoveShareAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardRemoveShareAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- groupId? int - Id of the group that was removed from the dashboard's sharing list. (Specific to remove share from group actions)
- userId? int - Id of the user that was removed from the dashboard's sharing list. (Specific to remove share from user actions)
smartsheet: DashboardRemoveShareMember
Fields
- Fields Included from *Event
- action? "REMOVE_SHARE_MEMBER" - The action applied to the specified object
- additionalDetails? DashboardRemoveShareMemberAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardRemoveShareMemberAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- groupId? int - Id of the group that the user was removed from
- userId? int - Id of user that was removed from the group
- workspaceId? int - Id of the workspace that the group is shared to. (Specific to cases where the dashboard is shared to the group via a workspace's sharing list)
smartsheet: DashboardRemoveWorkspaceShare
Fields
- Fields Included from *Event
- action? "REMOVE_WORKSPACE_SHARE" - The action applied to the specified object
- additionalDetails? DashboardRemoveWorkspaceShareAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardRemoveWorkspaceShareAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- groupId? int - Id of the group that was removed from the workspace. (Specific to remove share from group actions)
- userId? int - Id of the user that was removed from the workspace. (Specific to remove share from user actions)
- workspaceId? int - Id of the workspace the group or user was removed from
smartsheet: DashboardRename
Fields
- Fields Included from *Event
- action? "RENAME" - The action applied to the specified object
- additionalDetails? DashboardRenameAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardRenameAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- newName? string - New name of the dashboard
- oldName? string - Previous name of the dashboard
smartsheet: DashboardRestore
Fields
- Fields Included from *Event
- action? "RESTORE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardSaveAsNew
Fields
- Fields Included from *Event
- action? "SAVE_AS_NEW" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardTransferOwnership
Fields
- Fields Included from *Event
- action? "TRANSFER_OWNERSHIP" - The action applied to the specified object
- additionalDetails? DashboardTransferOwnershipAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DashboardTransferOwnershipAdditionalDetails
Fields
- newAccessLevel "OWNER" (default "OWNER") - New access level of the new owner:
"OWNER"
- emailAddress string - Email address of the user responsible for the event
- newUserId? int - Id of the new dashboard owner
- oldUserId? int - Id of the former dashboard owner
- oldAccessLevel "ADMIN" (default "ADMIN") - New access level of the former owner:
"ADMIN"
smartsheet: DashboardUpdate
Fields
- Fields Included from *Event
- action? "UPDATE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "DASHBOARD" - The Smartsheet resource impacted by the event
smartsheet: DateObjectValue
Fields
- value? string - Date in the full-date format defined by [(https://tools.ietf.org/html/rfc3339#section-5.6" target="_blank" rel="noopener noreferrer">RFC 3339, section 5.6]</a>
- objectType? "DATE" - Object representing a date
smartsheet: DatetimeObjectValue
Object representing a datetime
Fields
- value? string - Datetime, in the date-time format defined by <a href="https://tools.ietf.org/html/rfc3339#section-5.6" target="_blank" rel="noopener noreferrer">RFC 3339, section 5.6</a>
- objectType? "DATETIME" - Type of this object, always set to 'DATETIME'
smartsheet: DeactivateUserHeaders
Represents the Headers record for the operation: deactivate-user
Fields
smartsheet: DeleteAlternateEmailHeaders
Represents the Headers record for the operation: delete-alternate-email
Fields
smartsheet: DeleteFavoritesByTypeAndIdHeaders
Represents the Headers record for the operation: delete-favorites-by-type-and-id
Fields
- xSmarScActorId? string - UserId of the user
smartsheet: DeleteFavoritesByTypeHeaders
Represents the Headers record for the operation: delete-favorites-by-type
Fields
- xSmarScActorId? string - UserId of the user
smartsheet: DeleteFavoritesByTypeQueries
Represents the Queries record for the operation: delete-favorites-by-type
Fields
- objectIds string - A comma-separated list of Ids of the favorited item
smartsheet: DeleteFolderHeaders
Represents the Headers record for the operation: delete-folder
Fields
smartsheet: DeleteGroupHeaders
Represents the Headers record for the operation: delete-group
Fields
smartsheet: DeleteGroupMembersHeaders
Represents the Headers record for the operation: delete-group-members
Fields
smartsheet: DeleteReportShareHeaders
Represents the Headers record for the operation: delete-report-share
Fields
smartsheet: DeleteReportShareQueries
Represents the Queries record for the operation: delete-report-share
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
smartsheet: DeleteRowsHeaders
Represents the Headers record for the operation: delete-rows
Fields
smartsheet: DeleteRowsQueries
Represents the Queries record for the operation: delete-rows
Fields
- ids string - A comma-separated list of row Ids
smartsheet: DeleteSheetHeaders
Represents the Headers record for the operation: deleteSheet
Fields
smartsheet: DeleteSheetShareHeaders
Represents the Headers record for the operation: delete-sheet-share
Fields
smartsheet: DeleteSheetShareQueries
Represents the Queries record for the operation: delete-sheet-share
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
smartsheet: DeleteSightHeaders
Represents the Headers record for the operation: delete-sight
Fields
smartsheet: DeleteSightShareHeaders
Represents the Headers record for the operation: delete-sight-share
Fields
smartsheet: DeleteSummaryFieldsHeaders
Represents the Headers record for the operation: delete-summary-fields
Fields
smartsheet: DeleteSummaryFieldsQueries
Represents the Queries record for the operation: delete-summary-fields
Fields
- ignoreSummaryFieldsNotFound boolean(default false) - If true, the operation will succeed even if some fieldIds are not found
- ids string - A comma-separated list of Sheet Summary Field Ids
smartsheet: DeleteWebhookHeaders
Represents the Headers record for the operation: deleteWebhook
Fields
smartsheet: DeleteWorkspaceHeaders
Represents the Headers record for the operation: delete-workspace
Fields
smartsheet: DeleteWorkspaceShareHeaders
Represents the Headers record for the operation: delete-workspace-share
Fields
smartsheet: Discussion
Fields
- commentAttachments? Attachment[] - Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments
- comments? Comment[] - Array of comments in discussion. Only returned if the include query string parameter contains comments
- accessLevel? AccessLevel - Specifies the user's level of access or permissions, such as ADMIN, OWNER, EDITOR, or VIEWER
- createdBy? MiniUser -
Userobject containingnameandemailof the user who created the discussion
- readOnly? boolean - Indicates whether the user can modify the discussion
- id? decimal - Discussion Id
- lastCommentedAt? Timestamp -
- title? string - Title automatically created by duplicating the first 100 characters of top-level comment
- parentId? decimal - The Id of the associated row or sheet
- parentType? "ROW"|"SHEET" - Type of parent object
- commentCount? decimal - Number of comments in the discussion
- lastCommentedUser? MiniUser -
Userobject containingnameandemailof the user who last commented on the discussion
smartsheet: DiscussionAttachmentListResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- result? Discussion -
smartsheet: DiscussionCreate
Fields
- Fields Included from *Event
- action? "CREATE" - The action applied to the specified object
- additionalDetails? DiscussionCreateAdditionalDetails -
- objectType? "DISCUSSION" - The Smartsheet resource impacted by the event
smartsheet: DiscussionCreateAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- sheetRowId? int - Id of the sheet row containing the discussion. (this property is included only if the discussion is on a sheet row)
- sheetId? int - Id of the sheet the discussion is on. (This property is included only if the
workspaceIdproperty below isn't included)
- workspaceId? int - Id of the workspace the discussion is directly on. (This property is included only if the
sheetIdproperty above isn't included)
smartsheet: DiscussionCreateData
Fields
- data? Discussion[] - list of discussions
smartsheet: DiscussionCreateResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *DiscussionCreateData
- data Discussion[]
- anydata...
smartsheet: DiscussionCreationRequest
Fields
- comment? CommentRequest - Comment
smartsheet: DiscussionDelete
Fields
- Fields Included from *Event
- action? "DELETE" - The action applied to the specified object
- additionalDetails? DiscussionCreateAdditionalDetails -
- objectType? "DISCUSSION" - The Smartsheet resource impacted by the event
smartsheet: DiscussionDeleteHeaders
Represents the Headers record for the operation: discussion-delete
Fields
smartsheet: DiscussionGetHeaders
Represents the Headers record for the operation: discussion-get
Fields
smartsheet: DiscussionListAttachmentsHeaders
Represents the Headers record for the operation: discussion-listAttachments
Fields
smartsheet: DiscussionListAttachmentsQueries
Represents the Queries record for the operation: discussion-listAttachments
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: DiscussionListData
Fields
- result? CrossSheetReference -
smartsheet: DiscussionListResponse
Fields
- Fields Included from *DiscussionListData
- result CrossSheetReference
- anydata...
smartsheet: DiscussionsCreateHeaders
Represents the Headers record for the operation: discussions-create
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: DiscussionSend
Fields
- Fields Included from *Event
- action? "SEND" - The action applied to the specified object
- additionalDetails? DiscussionSendAdditionalDetails -
- objectType? "DISCUSSION" - The Smartsheet resource impacted by the event
smartsheet: DiscussionSendAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- includeAttachments? boolean - Indicates whether the discussion was sent with its respective attachments
- sheetRowId? int - Id of the sheet row containing the discussion. (this property is included only if the discussion is on a sheet row)
- sheetId? int - Id of the sheet the discussion is on. (This property is included only if the
workspaceIdproperty below isn't included)
- recipientGroupId? int - Single ID of a user group explicitly included in the recipient list. (This property is included only if the
recipientEmailproperty above isn't included)
- recipientEmail? string - Single email address either of a user explicitly included in the recipient list or of the sender (when CC sender is requested). (This property is included only if the
recipientGroupIdproperty below isn't included)
- workspaceId? int - Id of the workspace the discussion is directly on. (This property is included only if the
sheetIdproperty above isn't included)
smartsheet: DiscussionSendcomment
Fields
- Fields Included from *Event
- action? "SEND_COMMENT" - The action applied to the specified object
- additionalDetails? DiscussionSendcommentAdditionalDetails -
- objectType? "DISCUSSION" - The Smartsheet resource impacted by the event
smartsheet: DiscussionSendcommentAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- includeAttachments? boolean - Indicates whether the discussion comment (or discussion comment reply) was sent with its respective attachments
- sheetRowId? int - Id of the sheet row containing the discussion. (this property is included only if the discussion is on a sheet row)
- commentId? int - Id of the comment
- sheetId? int - Id of the sheet the discussion is on. (This property is included only if the
workspaceIdproperty below isn't included)
- recipientGroupId? int - Single ID of a user group explicitly included in the recipient list. (This property is included only if the
recipientEmailproperty above isn't included)
- recipientEmail? string - Single email address either of a user explicitly included in the recipient list or of the sender (when CC sender is requested). (This property is included only if the
recipientGroupIdproperty below isn't included)
- workspaceId? int - Id of the workspace the discussion is directly on. (This property is included only if the
sheetIdproperty above isn't included)
smartsheet: DiscussionsListHeaders
Represents the Headers record for the operation: discussions-list
Fields
smartsheet: DiscussionsListQueries
Represents the Queries record for the operation: discussions-list
Fields
- include? "attachments"|"comments" - A comma-separated list of optional elements to include in the response:
- attachments - effective only if comments is present, otherwise ignored
- comments - include all comments in threads
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: DiscussionUpdate
Fields
- Fields Included from *Event
- action? "UPDATE" - The action applied to the specified object
- additionalDetails? DiscussionCreateAdditionalDetails -
- objectType? "DISCUSSION" - The Smartsheet resource impacted by the event
smartsheet: Duration
In a project sheet, represents a value in a duration cell, or a lag value of a predecessor
Fields
- elapsed? boolean - If true, indicates this duration represents elapsed time, which ignores non-working time
- milliseconds? decimal - The number of milliseconds for this duration
- hours? decimal - The number of hours for this duration
- negative? boolean - When used as a predecessor's lag value, indicates whether the lag is negative (if true), or positive (false). The individual duration values themselves (for example, days, hours, or minutes) is always positive
- seconds? decimal - The number of seconds for this duration
- weeks? decimal - The number of weeks for this duration
- minutes? decimal - The number of minutes for this duration
- days? decimal - The number of days for this duration
- objectType? "DURATION" - Indicates the type of the object. For Duration, this will always be 'DURATION'
smartsheet: DurationObjectValue
Fields
- days? float - Number of days
- objectType? "DURATION" - Object representing a duration in days
smartsheet: Email
Fields
- sendTo? Recipient[] - Array of recipients
- ccMe? boolean - Indicates whether to send a copy of the email to the sender
- subject? string - The subject of the email
- message? string - The message of the email
smartsheet: Error
The error caused by the failed item
Fields
- errorCode? decimal - Custom error code from Smartsheet. See the complete Error Code List
- refId? string - The Id of the specific error occurrence. Please include this information when contacting Smartsheet support
- message? string - Descriptive error message
smartsheet: Event
The base object for Event Reporting events.
Note: Event Reporting is a premium add-on available for Enterprise and Advanced Work Management plans. For details on the Event Reporting add-on, please contact our Sales Team.
All event types include the Event properties and override the following properties:
objectType(string)action(string)additionalDetails(object)
See Event types for event descriptions and example event response objects
Fields
- eventId? string - Unique event identifier
- accessTokenName? string - Name of the access token embedded in the request. This property is omitted if there's no access token in the request (i.e., it isn't an API call) or if the access token wasn't given a name when created (only access tokens generated via the Smartsheet desktop UI can be given a name at creation time)
- action? string - The action applied to the specified object, such as CREATE, UPDATE, or DELETE. See Event types for actions associated with each event object type
- requestUserId? decimal - User whose authentication credential is embedded in the request that initiated the event. For example, if the request is an API call with an access token then requestUserId identifies the user whose data can be accessed via the access token (i.e., the user who authorized the creation of the access token). On the other hand, if the request comes from a UI session, then requestUserId identifies the user logged-in to the UI
- 'source? "WEB_APP"|"MOBILE_IOS"|"MOBILE_ANDROID"|"API_UNDEFINED_APP"|"API_INTEGRATED_APP"|"API_ODBC_DRIVER" - Identifies the client or user agent used to initiate the action
- additionalDetails? EventAdditionalDetails - Container object for additional event-specific properties. Properties depend upon the event type, but all events include an
emailAddressproperty, representing the user responsible for the event. See Event types for event details, including event-specificadditionalDetailsproperties and example event response objects
- userId? decimal - User assumed as the one who initiated the event. Usually the userId property and the requestUserId property (below) have the same value. However, if the request is an API call with Assume-User header then the userId property identifies the user whose email matches the value in the Assume-User header
- objectId? string - The identifier of the object impacted by the event
- objectType? string - The type of Smartsheet resource object impacted by the event. See Event types for all the event object types
- eventTimestamp? string - Date and time of the event. Defaults to ISO-8601 format. See dates and times for more information
smartsheet: EventAdditionalDetails
Container object for additional event-specific properties. Properties depend upon the event type, but all events include an emailAddress property, representing the user responsible for the event.
See Event types for event details, including event-specific additionalDetails properties and example event response objects
Fields
- emailAddress string - Email address of the user responsible for the event
smartsheet: EventFilterData
Fields
- data? Event[] - List of Events
smartsheet: EventFilterResponse
Fields
- Fields Included from *StreamResult
- Fields Included from *EventFilterData
smartsheet: EventStreamData
Fields
- data? EventUnionData[] - List of Events
smartsheet: EventStreamResponse
Fields
- Fields Included from *StreamResult
- Fields Included from *EventStreamData
- data EventUnionData[]
- anydata...
smartsheet: Favorite
Fields
- 'type? "folder"|"report"|"sheet"|"sight"|"template"|"workspace" -
- objectId? decimal - The Id of the favorited item. If type is template, only private sheet-type template Id is allowed
smartsheet: FavoriteData
Fields
- result? AutomationRule -
smartsheet: FavoriteResultResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *FavoritesResultData
smartsheet: FavoritesResultData
Fields
smartsheet: FilteredEventsRequest
Fields
- managedPlanId? decimal - The target managed plan for which to list events. Authorized if the caller is a licensed user on either the target managed plan or the main plan in EPM hierarchy
- streamPosition? string - Indicates next set of events to return. Use value of
nextStreamPositionreturned from the previous call. You must pass in a value for eithersinceorstreamPositionand never both
- sheetIds? string[] - Array of sheet Ids used to filter events. Only events related to the specified sheet Ids are returned
- workspaceIds? string[] - Array of workspace Ids used to filter events. Only events related to the specified workspace Ids are returned
- numericDates boolean(default false) - If true, dates are accepted and returned in Unix epoch time (milliseconds since midnight on January 1, 1970 in UTC time). Default is false, which means ISO-8601 format
- to? string - The latest time up to which events are included in the response. Events after this time are excluded. The
tofield requires using thesincebody field (above). This field is intended for use when backfilling data at client startup or recovery--don't use it for fine-grained date-based queries. Therefore, resolution is limited to the nearest hour. The value is interpreted as ISO-8601 format, unlessnumericDatesis specified (see details aboutnumericDatesbelow). Iftois a future time, the current time is used. Iftoequals thesincetime, an empty data value is returned. Iftois before thesincetime, an error is returned
- maxCount int(default 1000) - Maximum number of events to return as response to this call. Must be between 1 through 10,000 (inclusive). Defaults to 1,000 if not specified
- since? string - The earliest time from which events are included in the response. Events before this time are excluded. This field is intended for use when backfilling data at client startup or recovery--don't use it for fine-grained date-based queries. Therefore, resolution is limited to the nearest hour. The value is interpreted as ISO-8601 format, unless
numericDatesis specified (see details aboutnumericDatesbelow). You must pass in a value for eithersinceorstreamPositionand never both
smartsheet: Folder
Can contain dashboards, folders, reports, sheets, or templates
Fields
- reports? GridListing[] - Reports contained in folder
- sheets? GridListing[] - Sheets contained in folder
- folders? Folder[] - Folders contained in folder
- sights? DashboardListing[] - Dashboards contained in folder
- templates? GridListing[] - Templates contained in folder
- name? string - Folder name
- id? decimal - Folder Id
- permalink? string - URL that represents a direct link to the folder in Smartsheet
- favorite? boolean - Deprecated Returned only if the user has marked the folder as a favorite in their "Home" tab (value = true)
smartsheet: FolderContentItemData
Fields
- name? string - The folder's name
- id? decimal - The folder's unique identifier
- permalink? string - URL to the folder in Smartsheet
smartsheet: FolderContentsData
Fields
- data? FolderContentItemData[] - Array of all the workspace folders, referenced by their ID, name, and URL
smartsheet: FolderContentsResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *FolderContentsData
- data FolderContentItemData[]
- anydata...
smartsheet: FolderCopyData
Fields
- data? AlternateEmail[] - list of alternate email results
smartsheet: FolderCopyResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *FolderCopyData
- data AlternateEmail[]
- anydata...
smartsheet: FolderCreate
Fields
- Fields Included from *Event
- action? "CREATE" - The action applied to the specified object
- additionalDetails? FolderCreateAdditionalDetails -
- objectType? "FOLDER" - The Smartsheet resource impacted by the event
smartsheet: FolderCreateAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- sourceFolderId? int - Id of folder that was copied to create the new folder. (Only included if the folder was created as a result of a save as new or copy)
- folderName? string - Name of the destination folder for the move event. (Specific to actions where the folder was moved to a different folder)
smartsheet: FolderCreateData
Fields
- data? AlternateEmail[] - Updated User Properties
smartsheet: FolderCreateResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *FolderCreateData
- data AlternateEmail[]
- anydata...
smartsheet: FolderDelete
Fields
- Fields Included from *Event
- action? "DELETE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "FOLDER" - The Smartsheet resource impacted by the event
smartsheet: FolderExport
Fields
- Fields Included from *Event
- action? "EXPORT" - The action applied to the specified object
- additionalDetails? FolderExportAdditionalDetails -
- objectType? "FOLDER" - The Smartsheet resource impacted by the event
smartsheet: FolderExportAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- formatType? "excel"|"pdf" - The format that the folder was exported. Notice that the same value "excel" is displayed either when exporting to Microsoft Excel or when exporting to Google Sheets
smartsheet: FolderListData
Fields
- data? AlternateEmail[] - list of attachments
smartsheet: FolderListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *FolderListData
- data AlternateEmail[]
- anydata...
smartsheet: FolderNameOnly
Can contain dashboards, folders, reports, sheets, or templates
Fields
- name? string - Folder name
smartsheet: FolderRename
Fields
- Fields Included from *Event
- action? "RENAME" - The action applied to the specified object
- additionalDetails? FolderRenameAdditionalDetails -
- objectType? "FOLDER" - The Smartsheet resource impacted by the event
smartsheet: FolderRenameAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- newName? string - New name of the folder
- oldName? string - Old name of the folder
smartsheet: FolderRequestBackup
Fields
- Fields Included from *Event
- action? "REQUEST_BACKUP" - The action applied to the specified object
- additionalDetails? FolderRequestBackupAdditionalDetails -
- objectType? "FOLDER" - The Smartsheet resource impacted by the event
smartsheet: FolderRequestBackupAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- includeAttachments? boolean - Indicates whether attachments should be included in the recurring backup
- sendCompletionEmail? boolean - Indicates whether an email should be sent to the workspace's owner every time a recurring backup completes
smartsheet: FolderSaveAsNew
Fields
- Fields Included from *Event
- action? "SAVE_AS_NEW" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "FOLDER" - The Smartsheet resource impacted by the event
smartsheet: FolderSimpleResponse
Can contain dashboards, folders, reports, sheets, or templates
Fields
- name? string - Folder name
smartsheet: FontFamily
Fields
- traits? ("sans-serif"|"serif")[] - Platform-independent traits of the font family. Contains one of the listed enum values
- name? string - Name of the font family
smartsheet: FormActivate
Fields
- Fields Included from *Event
- action? "ACTIVATE" - The action applied to the specified object
- additionalDetails? FormActivateAdditionalDetails -
- objectType? "FORM" - The Smartsheet resource impacted by the event
smartsheet: FormActivateAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- sheetId? int - Id of the form's sheet
smartsheet: FormatTables
Contains all of the lookup tables that the format descriptor indexes refer to. Here the examples show the formatting options, the default value is used to denote each option. NOTE -- Indexes and their values are guaranteed never to change or be removed for a given major API version. However, new values could potentially be added to the ends of lookup tables. Because of this possibility, your code should handle the case where a cell might contain a format index value greater than the size of a lookup table your app has loaded. Your application should check for that case and reload the format tables if necessary
Fields
- verticalAlign? string[] - The default setting is "default" which is equivalent to "top"
- color? string[] - The default setting is "none". Typically this is black text and a white background
- dateFormat? string[] - Format used for dates
- underline? string[] - Indicates if the text is underlined
- bold? string[] - Indicates if the text is bold
- italic? string[] - Indicates if the text is italic
- fontFamily? FontFamily[] - Font family used for the text
- defaults? string - A format descriptor where each element describes the formats the Smartsheet Web app displays for format values that have not been set. Each value refers to an index of the following options
- numberFormat? string[] - Format used for numbers
- horizontalAlign? string[] - The default setting is "default" which is equivalent to "left"
- textWrap? string[] - Indicates if the text is wrapped
- currency? Currency[] - Currency code
- fontSize? string[] - Font size of the text
- strikethrough? string[] - Indicates if the text has a strikethrough
- decimalCount? string[] - Number of decimal places
- thousandsSeparator? string[] - Character used as thousands separator
smartsheet: FormCreate
Fields
- Fields Included from *Event
- action? "CREATE" - The action applied to the specified object
- additionalDetails? FormCreateAdditionalDetails -
- objectType? "FORM" - The Smartsheet resource impacted by the event
smartsheet: FormCreateAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- formName? string - Name of the form
- sheetId? int - Id of the form's sheet
smartsheet: FormDeactivate
Fields
- Fields Included from *Event
- action? "DEACTIVATE" - The action applied to the specified object
- additionalDetails? FormActivateAdditionalDetails -
- objectType? "FORM" - The Smartsheet resource impacted by the event
smartsheet: FormDelete
Fields
- Fields Included from *Event
- action? "DELETE" - The action applied to the specified object
- additionalDetails? FormActivateAdditionalDetails -
- objectType? "FORM" - The Smartsheet resource impacted by the event
smartsheet: FormUpdate
Fields
- Fields Included from *Event
- action? "UPDATE" - The action applied to the specified object
- additionalDetails? FormActivateAdditionalDetails -
- objectType? "FORM" - The Smartsheet resource impacted by the event
smartsheet: GenericResult
Fields
- resultCode? 0|3 -
- '0' Success
- '3' Partial Success of Bulk Operation
- message? "PARTIAL_SUCCESS"|"SUCCESS" - Message that indicates the outcome of the request. (One of SUCCESS or PARTIAL_SUCCESS.)
smartsheet: GetAlternateEmailHeaders
Represents the Headers record for the operation: get-alternate-email
Fields
smartsheet: GetColumn
Fields
- symbol? string - When applicable for CHECKBOX or PICKLIST column types. See Symbol Columns
- index? decimal - Column index or position. This number is zero-based
- id? decimal - Column Id
- title? string - Column title
- 'type? "ABSTRACT_DATETIME"|"CHECKBOX"|"CONTACT_LIST"|"DATE"|"DATETIME"|"DURATION"|"MULTI_CONTACT_LIST"|"MULTI_PICKLIST"|"PICKLIST"|"PREDECESSOR"|"TEXT_NUMBER" - See Column Types
- validation? boolean - Indicates whether validation has been enabled for the column (value = true)
smartsheet: GetContactHeaders
Represents the Headers record for the operation: get-contact
Fields
smartsheet: GetContactQueries
Represents the Queries record for the operation: get-contact
Fields
- include? "profileImage" - A comma-separated list of optional elements to include in the response:
- profileImage
smartsheet: GetCrosssheetReferenceHeaders
Represents the Headers record for the operation: get-crosssheet-reference
Fields
smartsheet: GetCurrentUserHeaders
Represents the Headers record for the operation: get-current-user
Fields
smartsheet: GetCurrentUserQueries
Represents the Queries record for the operation: get-current-user
Fields
- include? "groups" - When specified with a value of 'groups', response includes an array of groups (groupId, name, and description only) that the user is a member of
smartsheet: GetFavoritesHeaders
Represents the Headers record for the operation: get-favorites
Fields
- xSmarScActorId? string - UserId of the user
smartsheet: GetFavoritesQueries
Represents the Queries record for the operation: get-favorites
Fields
- include? "directId"|"name" - A comma-separated list of optional elements to include in the response
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: GetFolderHeaders
Represents the Headers record for the operation: get-folder
Fields
smartsheet: GetFolderQueries
Represents the Queries record for the operation: get-folder
Fields
- include? "source"|"distributionLink"|"ownerInfo"|"sheetVersion" - A comma-separated list of optional elements to include in the response:
- source - adds the Source object indicating which object the folder was created from, if any
- distributionLink
- ownerInfo Returns the user with owner permissions, or the user with admin permissions if there is no owner assigned. If no owner or admins are assigned, the Plan Asset Admin is returned. If no Plan Asset Admin is assigned, the System Admin is returned.
- sheetVersion
- permalinks
smartsheet: GetGroupHeaders
Represents the Headers record for the operation: get-group
Fields
smartsheet: GetReportHeaders
Represents the Headers record for the operation: getReport
Fields
- accept? string - The Accept request-header field can be used to specify certain media types which are acceptable for the response
smartsheet: GetReportPublishHeaders
Represents the Headers record for the operation: getReportPublish
Fields
smartsheet: GetReportQueries
Represents the Queries record for the operation: getReport
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- include? "attachments"|"discussions"|"proofs"|"format"|"objectValue"|"scope"|"source"|"sourceSheets" - A comma-separated list of optional elements to include in the response:
- attachments
- discussions
- proofs
- format
- objectValue - when used in combination with a level query parameter, includes the email addresses for multi-contact data
- scope - adds the report's scope to the response
- source - adds the Source object indicating which report the report was created from, if any
- sourceSheets
- level int(default 0) - specifies whether new functionality, such as multi-contact data is returned in a backwards-compatible, text format (level=0, default), multi-contact data (level=1), or multi-picklist data (level=3)
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- exclude? "linkInFromCellDetails"|"linksOutToCellsDetails" - A comma-separated list of optional elements to not include in the response
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: GetReportsHeaders
Represents the Headers record for the operation: getReports
Fields
smartsheet: GetReportsQueries
Represents the Queries record for the operation: getReports
Fields
- modifiedSince? Timestamp - When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version
smartsheet: GetRowObject
Fields
- createdAt? Timestamp -
- expanded? boolean - Indicates whether the row is expanded or collapsed
- cells? CellObjectForRows[] - Cells objects
- modifiedAt? Timestamp -
- sheetId? decimal - Parent sheet Id
- id? decimal - Row Id
- rowNumber? decimal - Row number within the sheet
smartsheet: GetSheetHeaders
Represents the Headers record for the operation: getSheet
Fields
- accept? string - The Accept request-header field can be used to specify certain media types which are acceptable for the response
smartsheet: GetSheetPublishHeaders
Represents the Headers record for the operation: get-sheetPublish
Fields
smartsheet: GetSheetQueries
Represents the Queries record for the operation: getSheet
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- include? "attachments"|"columnType"|"crossSheetReferences"|"discussions"|"filters"|"filterDefinitions"|"format"|"ganttConfig"|"objectValue"|"ownerInfo"|"rowPermalink"|"source"|"writerInfo" - A comma-separated list of optional elements to include in the response:
- attachments - includes the metadata for sheet-level and row-level attachments. To include discussion attachments, both attachments and discussions must be present in the include list.
- columnType -includes columnType attribute in the row's cells indicating the type of the column the cell resides in.
- crossSheetReferences - includes the cross-sheet references
- discussions - includes sheet-level and row-level discussions. To include discussion attachments, both attachments and discussions must be present in the include list.
- filters - includes filteredOut attribute indicating if the row should be displayed or hidden according to the sheet's filters.
- filterDefinitions - includes type of filter, operators used, and criteria
- format - includes column, row, cell, and summary fields formatting.
- ganttConfig - includes Gantt chart details.
- objectValue - when used in combination with a level query parameter, includes the email addresses for multi-contact data.
- ownerInfo - includes the owner's email address and the owner's user Id.
- rowPermalink - includes permalink attribute that represents a direct link to the row in the Smartsheet application.
- source - adds the Source object indicating which report, sheet Sight (aka dashboard), or template the sheet was created from, if any.
- writerInfo - includes createdBy and modifiedBy attributes on the row or summary fields, indicating the row or summary field's creator, and last modifier
- level int(default 0) - Specifies whether object data types, such as multi-contact data are returned in a backwards-compatible, text format in text/number columns.<br> - Set
level=0(default) to use text/number columns for multi-contact data and multi-picklist data.<br> - Setlevel=1to use multiple-entry contact list columns for multi-contact data; multi-picklist data is returned in text/number columns.<br> - Setlevel=2to use multiple-entry contact list columns for multi-contact data and use multiple-entry picklist columns for multi-picklist data
- rowIds? string - A comma-separated list of row Ids on which to filter the rows included in the result
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- paperSize "LETTER"|"LEGAL"|"WIDE"|"ARCHD"|"A4"|"A3"|"A2"|"A1"|"A0" (default "LETTER") - applies to PDF format only
- ifVersionAfter? int - If version specified is still the current sheet version, then returns an abbreviated Sheet object with only the sheet version property. Otherwise, if the sheet has been modified, returns the complete Sheet object. Intended to allow clients with a cached copy to make sure they have the latest version
- filterId? string - Overrides the existing include={filters} parameter if both are supplied. Applies the given filter (if accessible by the calling user) and marks the affected rows as "filteredOut": true
- columnIds? string - A comma-separated list of column ids. The response contains only the specified columns in the "columns" array, and individual rows' "cells" array only contains cells in the specified columns
- rowNumbers? string - A comma-separated list of row numbers on which to filter the rows included in the result. Non-existent row numbers are ignored
- exclude? "filteredOutRows"|"linkInFromCellDetails"|"linksOutToCellsDetails"|"nonexistentCells" - A comma-separated list of element types to exclude from the response:
- filteredOutRows - excludes filtered-out rows from response payload if a sheet filter is applied; includes total number of filtered rows
- linkInFromCellDetails - excludes the following attributes from the cell.linkInFromCell object:
columnId,rowId,status - linksOutToCellsDetails - excludes the following attributes from the cell.linksOutToCells array elements:
columnId,rowId,status - nonexistentCells - excludes empty cells
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
- rowsModifiedSince? Timestamp - Filter to return only rows that have been modified since the date/time provided. Date should be in ISO-8601 format
smartsheet: GetSheetVersionHeaders
Represents the Headers record for the operation: get-sheetVersion
Fields
smartsheet: GetSightHeaders
Represents the Headers record for the operation: get-sight
Fields
smartsheet: GetSightPublishStatusHeaders
Represents the Headers record for the operation: get-sight-publish-status
Fields
smartsheet: GetSightQueries
Represents the Queries record for the operation: get-sight
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- include? "objectValue"|"source" - A comma-separated list of optional elements to include in the response:
- objectValue - when used in combination with a level query parameter, includes the email addresses for multi-contact data.
- source - the Source object for any Sight that was created from another Sight, if any
- level int(default 0) - Specifies whether new functionality, such as multi-contact data is returned in a backwards-compatible, text format (level=0, default), multi-contact data (level=2), multi-picklist data (level=3), or Metric widget with sheet summary (level=4)
- numericDates boolean(default false) - You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request
smartsheet: GetUserHeaders
Represents the Headers record for the operation: get-user
Fields
smartsheet: GetWebhookHeaders
Represents the Headers record for the operation: getWebhook
Fields
smartsheet: GetWorkspaceFoldersHeaders
Represents the Headers record for the operation: get-workspace-folders
Fields
smartsheet: GetWorkspaceFoldersQueries
Represents the Queries record for the operation: get-workspace-folders
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: GetWorkspaceHeaders
Represents the Headers record for the operation: get-workspace
Fields
smartsheet: GetWorkspaceQueries
Represents the Queries record for the operation: get-workspace
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- include? "source"|"distributionLink"|"ownerInfo"|"sheetVersion" - A comma-separated list of optional elements to include in the response:
- source - adds the Source object indicating which object the folder was created from, if any
- distributionLink
- ownerInfo Returns the user with owner permissions, or the user with admin permissions if there is no owner assigned. If no owner or admins are assigned, the Plan Asset Admin is returned. If no Plan Asset Admin is assigned, the System Admin is returned.
- sheetVersion
- permalinks
- loadAll boolean(default false) - If set to
true, the workspace's entire hierarchy of items and folders is returned
smartsheet: GridListing
Fields
- name? string - Asset name
- id? decimal - Asset Id
- permalink? string - URL that represents a direct link to the asset in Smartsheet
smartsheet: Group
Fields
- owner? string - Group owner’s email address
- createdAt? Timestamp -
- modifiedAt? Timestamp -
- name? string - Group name
- description? string - Group description
- id? decimal - Group Id
- ownerId? decimal - Group owner's user Id
smartsheet: GroupAddMember
Fields
- Fields Included from *Event
- action? "ADD_MEMBER" - The action applied to the specified object
- additionalDetails? GroupAddMemberAdditionalDetails -
- objectType? "GROUP" - The Smartsheet resource impacted by the event
smartsheet: GroupAddMemberAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- memberUserId? int - Id of the user that was added to the group
smartsheet: GroupCreate1
Create group request
Fields
- members? GroupMembersAddArray - An array of GroupMemberAdd objects, each specifying the email address of a user to be added to a group
- name? string - name (required) Must be unique within the organization account
- description? string - description (optional)
smartsheet: GroupCreateData
Fields
- result? Group -
smartsheet: GroupCreateResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *GroupCreateData
- result Group
- anydata...
smartsheet: GroupData
Fields
- data? Group[] - List of Groups
smartsheet: GroupDelete
Fields
- Fields Included from *Event
- action? "DELETE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "GROUP" - The Smartsheet resource impacted by the event
smartsheet: GroupDownloadSheetAccessReport
Fields
- Fields Included from *Event
- action? "DOWNLOAD_SHEET_ACCESS_REPORT" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "GROUP" - The Smartsheet resource impacted by the event
smartsheet: GroupMember
Fields
- firstName? string - Group member's first name
- lastName? string - Group member's last name
- name? string - Group member's full name
- id? decimal - Group member's user Id
- email? string - Group member's email address
smartsheet: GroupMemberAdd
Fields
- email? string - Group member's email address
smartsheet: GroupMembersData
Fields
- members? GroupMember[] - List of Group Members
smartsheet: GroupMembersListData
Fields
- result? GroupMember|GroupMember[] -
smartsheet: GroupMembersListResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *GroupMembersListData
- result GroupMember|GroupMember[]
- anydata...
smartsheet: GroupMembersResponse
Fields
- Fields Included from *Group
- Fields Included from *GroupMembersData
- members GroupMember[]
- anydata...
smartsheet: GroupRemoveMember
Fields
- Fields Included from *Event
- action? "REMOVE_MEMBER" - The action applied to the specified object
- additionalDetails? GroupRemoveMemberAdditionalDetails -
- objectType? "GROUP" - The Smartsheet resource impacted by the event
smartsheet: GroupRemoveMemberAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- memberUserId? int - Id of the user that was removed from the group
smartsheet: GroupRename
Fields
- Fields Included from *Event
- action? "RENAME" - The action applied to the specified object
- additionalDetails? GroupRenameAdditionalDetails -
- objectType? "GROUP" - The Smartsheet resource impacted by the event
smartsheet: GroupRenameAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- newName? string - New name of the group
- oldName? string - Old name of the group
smartsheet: GroupResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *GroupData
- data Group[]
- anydata...
smartsheet: GroupTransferOwnership
Fields
- Fields Included from *Event
- action? "TRANSFER_OWNERSHIP" - The action applied to the specified object
- additionalDetails? GroupTransferOwnershipAdditionalDetails -
- objectType? "GROUP" - The Smartsheet resource impacted by the event
smartsheet: GroupTransferOwnershipAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- oldOwnerUserId? int - Id of the former group owner
- newOwnerUserId? int - Id of the new group owner
smartsheet: GroupUpdate1
Updates group properties, including name, description, and owner
Fields
- name? string - name (Optional) Must be unique within the organization account
- description? string - Description (optional)
- ownerId? decimal - ownerId (optional) Id of an admin user to whom the group ownership is transferred
smartsheet: Home
All objects a user has access to, including dashboards, folders, reports, sheets, and templates
Fields
- reports? Report[] - Reports accessible to the user
- sheets? Sheet[] - Sheets accessible to the user
- folders? Folder[] - Folders accessible to the user
- sights? Sight[] - Dashboards (Sights) accessible to the user
- templates? Template[] - Templates accessible to the user
smartsheet: HomeContentsData
Fields
- data? SheetList[] - List of Sheets
smartsheet: HomeContentsResponse
Fields
- Fields Included from *IndexResultUnknownPages
- Fields Included from *HomeContentsData
- data SheetList[]
- anydata...
smartsheet: HomeFolderCreateData
Fields
- data? UserProfileImageResponse[] - Updated User Properties
smartsheet: HomeFolderCreateResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *HomeFolderCreateData
- data UserProfileImageResponse[]
- anydata...
smartsheet: HomeListFoldersHeaders
Represents the Headers record for the operation: home-list-folders
Fields
smartsheet: HomeListFoldersQueries
Represents the Queries record for the operation: home-list-folders
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: Hyperlink
Represents a hyperlink, which can be a URL or a link to a report, sheet, or dashboard
Fields
- reportId? decimal - If non-null, this hyperlink is a link to the report with this Id
- sheetId? decimal - If non-null, this hyperlink is a link to the sheet with this Id
- sightId? decimal - If non-null, this hyperlink is a link to the dashboard with this Id
- url? string - When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a dashboard/report/sheet link (that is, dashboardId, reportId, or sheetId is non-null), this property contains the permalink to the dashboard, report, or sheet
smartsheet: Image
Represents an image object, including its unique ID, dimensions, and alternate text
Fields
- altText? string - Alternate text for the image
- width? decimal - Original width (in pixels) of the uploaded image
- id? string - Image Id
- height? decimal - Original height (in pixels) of the uploaded image
smartsheet: ImageUrl
Fields
- imageId? string - Image Id
- width? decimal - Image width in pixels
- 'error? Error - The error caused by the failed item
- url? string - Temporary URL that can be used to retrieve the image. This attribute can be present in a response but is never specified in a request
- height? decimal - Image height in pixels
smartsheet: ImageUrlMap
Fields
- urlExpiresInMillis? decimal - Milliseconds before the URLs within imageUrls expire
- imageUrls? ImageUrl[] -
smartsheet: ImportSheetIntoFolderHeaders
Represents the Headers record for the operation: import-sheet-into-folder
Fields
- contentDisposition? string - Should be equal to "attachment" to tell the API that a file is in the body of the POST request, followed by a semicolon, followed by filename= and the URL-encoded filename in quotes
- contentType "text/csv"|"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Required for POST request to import a sheet from CSV/XLSX file.
- For CSV files, use: Content-Type: text/csv
- For XLSX files, use: Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
smartsheet: ImportSheetIntoFolderQueries
Represents the Queries record for the operation: import-sheet-into-folder
Fields
- sheetName string - Desired name of the sheet
- headerRowIndex? decimal - A zero-based integer indicating the row number to use for column names. Rows before this are omitted. If not specified, the default values are Column1, Column2, etc
- primaryColumnIndex decimal(default 0) - A zero-based integer indicating the column to designate as primary
smartsheet: ImportSheetIntoSheetsFolderHeaders
Represents the Headers record for the operation: import-sheet-into-sheets-folder
Fields
- contentDisposition? string - Should be equal to "attachment" to tell the API that a file is in the body of the POST request, followed by a semicolon, followed by filename= and the URL-encoded filename in quotes
- contentType "text/csv"|"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Required for POST request to import a sheet from CSV/XLSX file.
- For CSV files, use: Content-Type: text/csv
- For XLSX files, use: Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
smartsheet: ImportSheetIntoSheetsFolderQueries
Represents the Queries record for the operation: import-sheet-into-sheets-folder
Fields
- sheetName string - Desired name of the sheet
- headerRowIndex? decimal - A zero-based integer indicating the row number to use for column names. Rows before this are omitted. If not specified, the default values are Column1, Column2, etc
- primaryColumnIndex decimal(default 0) - A zero-based integer indicating the column to designate as primary
smartsheet: ImportSheetIntoWorkspaceHeaders
Represents the Headers record for the operation: import-sheet-into-workspace
Fields
- contentDisposition? string - Should be equal to "attachment" to tell the API that a file is in the body of the POST request, followed by a semicolon, followed by filename= and the URL-encoded filename in quotes
- contentType "text/csv"|"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Required for POST request to import a sheet from CSV/XLSX file.
- For CSV files, use: Content-Type: text/csv
- For XLSX files, use: Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
smartsheet: ImportSheetIntoWorkspaceQueries
Represents the Queries record for the operation: import-sheet-into-workspace
Fields
- sheetName string - Desired name of the sheet
- headerRowIndex? decimal - A zero-based integer indicating the row number to use for column names. Rows before this are omitted. If not specified, the default values are Column1, Column2, etc
- primaryColumnIndex decimal(default 0) - A zero-based integer indicating the column to designate as primary
smartsheet: IndexResult
Fields
- pageNumber? decimal - The current page in the full result set that the data array represents. NOTE when a page number greater than totalPages is requested, the last page is instead returned
- totalPages? decimal - The total number of pages in the full result set
- pageSize? decimal? - The number of items in a page. Omitted if there is no limit to page size (and hence, all results are included). Unless otherwise specified, this defaults to 100 for most endpoints
- totalCount? decimal - The total number of items in the full result set
smartsheet: IndexResultUnknownPages
Fields
- pageNumber? decimal - The current page in the full result set that the data array represents. NOTE when a page number greater than totalPages is requested, the last page is instead returned
- totalPages? decimal - If the data field value is not empty, returns a static value of -1. When you reach the first empty page after the end of the result set, then all four fields are set with a static value of “0”
- pageSize? decimal? - The number of items in a page. Omitted if there is no limit to page size (and hence, all results are included). Unless otherwise specified, this defaults to 100 for most endpoints
- totalCount? decimal - If the data field value is not empty, returns a static value of -1. When you reach the first empty page after the end of the result set, then all four fields are set with a static value of “0”
smartsheet: IsFavoriteHeaders
Represents the Headers record for the operation: is-favorite
Fields
- xSmarScActorId? string - UserId of the user
smartsheet: IsFavoriteQueries
Represents the Queries record for the operation: is-favorite
Fields
- include? "directId"|"name" - A comma-separated list of optional elements to include in the response
smartsheet: ListAlternateEmailsHeaders
Represents the Headers record for the operation: list-alternate-emails
Fields
smartsheet: ListContactsHeaders
Represents the Headers record for the operation: list-contacts
Fields
smartsheet: ListContactsQueries
Represents the Queries record for the operation: list-contacts
Fields
- modifiedSince? Timestamp - When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version
- numericDates boolean(default false) - You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ListCrosssheetReferencesHeaders
Represents the Headers record for the operation: list-crosssheet-references
Fields
smartsheet: ListCrosssheetReferencesQueries
Represents the Queries record for the operation: list-crosssheet-references
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ListEventsHeaders
Represents the Headers record for the operation: list-events
Fields
- acceptEncoding? "deflate"|"gzip" - Strongly recommended to make sure payload is compressed. Must be set to one of the following values:
- deflate
- gzip
smartsheet: ListEventsQueries
Represents the Queries record for the operation: list-events
Fields
- managedPlanId? decimal - The target managed plan for which to list events. Authorized if the caller is a system administrator on either the target managed plan or the main plan in EPM hierarchy
- streamPosition? string - Indicates next set of events to return. Use value of
nextStreamPositionreturned from the previous call. This parameter is required ifsinceis not used
- numericDates boolean(default false) - If
true, dates are accepted and returned in Unix epoch time (milliseconds since midnight on January 1, 1970 in UTC time). Default isfalse, which means ISO-8601 format
- to? string - The latest time up to which events are included in the response. Events after this time are excluded.
This parameter requires using the
sinceparameter. The date-time value is resolved to the nearest hour. The value is interpreted as ISO-8601 format, unlessnumericDatesis specified (see details aboutnumericDatesbelow). Logic:- If
tois a future time, the current time is used. - If
toequals thesincetime, an empty data value is returned. - If
tois before thesincetime, a validation error is returned.
IMPORTANT: This parameter is intended for use when backfilling data at client startup or recovery--don't use it for fine-grained, date-based queries
- If
- maxCount Signed32(default 1000) - Maximum number of events to return as response to this call. Must be between 1 through 10,000 (inclusive). Defaults to 1,000 if not specified
- since? string - The earliest time from which events are included in the response. Events before this time are excluded.
This parameter is required if
streamPositionis not used. The date-time value is resolved to the nearest hour. The value is interpreted as ISO-8601 format, unlessnumericDatesis specified (see details aboutnumericDatesbelow).IMPORTANT: To keep event responses manageable and prevent timeouts, also specify the
toquery parameter.IMPORTANT: This parameter is intended for use when backfilling data at client startup or recovery--don't use it for fine-grained, date-based queries
smartsheet: ListFilteredEventsHeaders
Represents the Headers record for the operation: list-filtered-events
Fields
- acceptEncoding? "deflate"|"gzip" - Strongly recommended to make sure payload is compressed. Must be set to one of the following values:
- deflate
- gzip
smartsheet: ListFoldersHeaders
Represents the Headers record for the operation: list-folders
Fields
smartsheet: ListFoldersQueries
Represents the Queries record for the operation: list-folders
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ListGroupsHeaders
Represents the Headers record for the operation: list-groups
Fields
smartsheet: ListGroupsQueries
Represents the Queries record for the operation: list-groups
Fields
- modifiedSince? Timestamp - When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version
- numericDates boolean(default false) - You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ListHomeContentsHeaders
Represents the Headers record for the operation: list-home-contents
Fields
smartsheet: ListHomeContentsQueries
Represents the Queries record for the operation: list-home-contents
Fields
- include? "source"|"distributionLink"|"ownerInfo"|"sheetVersion" - A comma-separated list of optional elements to include in the response:
- source - adds the Source object indicating which object the folder was created from, if any
- distributionLink
- ownerInfo Returns the user with owner permissions, or the user with admin permissions if there is no owner assigned. If no owner or admins are assigned, the Plan Asset Admin is returned. If no Plan Asset Admin is assigned, the System Admin is returned.
- sheetVersion
- permalinks
smartsheet: ListImageUrlsHeaders
Represents the Headers record for the operation: listImageUrls
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: ListOrgSheetsHeaders
Represents the Headers record for the operation: list-org-sheets
Fields
smartsheet: ListOrgSheetsQueries
Represents the Queries record for the operation: list-org-sheets
Fields
- modifiedSince? Timestamp - When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version
smartsheet: ListReportSharesHeaders
Represents the Headers record for the operation: list-report-shares
Fields
smartsheet: ListReportSharesQueries
Represents the Queries record for the operation: list-report-shares
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ListSearchHeaders
Represents the Headers record for the operation: list-search
Fields
smartsheet: ListSearchQueries
Represents the Queries record for the operation: list-search
Fields
- include string(default "") - When specified with a value of favoriteFlag, response indicates which returned items are favorites. favorite -- dashboards, folders, reports, sheets, templates, and workspaces will have the property favorite: true parentObjectFavorite -- attachments, discussions, summary fields, and rows will have the property parentObjectFavorite: true
- modifiedSince? Timestamp - When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version
- query string - Text with which to perform the search. Enclose in double-quotes for an exact search
- location string(default "") - Deprecated When specified with a value of personalWorkspace, limits the response to only those items in the user's workspaces
- scopes? ("attachments"|"cellData"|"comments"|"folderNames"|"reportNames"|"sheetNames"|"sightNames"|"summaryFields"|"templateNames"|"workspaceNames")[] - If search fails, try using an array for each type of this comma-separated list of search filters
smartsheet: ListSearchSheetHeaders
Represents the Headers record for the operation: list-search-sheet
Fields
smartsheet: ListSearchSheetQueries
Represents the Queries record for the operation: list-search-sheet
Fields
- query string - Text with which to perform the search. Enclose in double-quotes for an exact search
smartsheet: ListSheetSharesHeaders
Represents the Headers record for the operation: list-sheet-shares
Fields
smartsheet: ListSheetSharesQueries
Represents the Queries record for the operation: list-sheet-shares
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ListSheetsHeaders
Represents the Headers record for the operation: list-sheets
Fields
smartsheet: ListSheetsQueries
Represents the Queries record for the operation: list-sheets
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- include? "sheetVersion"|"source" - A comma-separated list of optional elements to include in the response:
- sheetVersion - current version number of each sheet, should not be combined with pagination
- source - the Source object for any sheet that was created from another sheet, if any
- modifiedSince? Timestamp - When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version
- numericDates boolean(default false) - You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ListSightSharesHeaders
Represents the Headers record for the operation: list-sight-shares
Fields
smartsheet: ListSightSharesQueries
Represents the Queries record for the operation: list-sight-shares
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ListSightsHeaders
Represents the Headers record for the operation: list-sights
Fields
smartsheet: ListSightsQueries
Represents the Queries record for the operation: list-sights
Fields
- modifiedSince? Timestamp - When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version
- numericDates boolean(default false) - You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ListSummaryFieldsHeaders
Represents the Headers record for the operation: list-summary-fields
Fields
smartsheet: ListSummaryFieldsPaginatedHeaders
Represents the Headers record for the operation: list-summary-fields-paginated
Fields
smartsheet: ListSummaryFieldsPaginatedQueries
Represents the Queries record for the operation: list-summary-fields-paginated
Fields
- include? "format"|"writerInfo" - A comma-separated list of elements to include in the response.
- format: includes format info for cells, rows, and summary fields
- writerInfo: includes createdBy and modifiedBy attributes for rows and summary fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- exclude? "displayValue"|"image"|"imageAltText" - A comma-separated list of elements to not include in the response.
- displayValue: excludes displayValue info for cells, rows, and summary fields
- image: excludes image attributes for cells and summary fields
- imageAltText: excludes alt text for cells and summary fields
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ListSummaryFieldsQueries
Represents the Queries record for the operation: list-summary-fields
Fields
- include? "format"|"writerInfo" - A comma-separated list of elements to include in the response.
- format: includes format info for cells, rows, and summary fields
- writerInfo: includes createdBy and modifiedBy attributes for rows and summary fields
- exclude? "displayValue"|"image"|"imageAltText" - A comma-separated list of elements to not include in the response.
- displayValue: excludes displayValue info for cells, rows, and summary fields
- image: excludes image attributes for cells and summary fields
- imageAltText: excludes alt text for cells and summary fields
smartsheet: ListUsersHeaders
Represents the Headers record for the operation: list-users
Fields
smartsheet: ListUsersQueries
Represents the Queries record for the operation: list-users
Fields
- include? string - If the API request is submitted by a system administrator and when specified with a value of 'lastLogin', response includes a lastLogin attribute for each user that indicates the Last login date/time of the user. Note If the number of users included in the response is > 100, you must paginate your query to see the lastLogin attribute. For large responses, the lastLogin attribute is never included
- numericDates boolean(default false) - You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
- email? string - Comma-separated list of email addresses on which to filter the results
smartsheet: ListWebhooksHeaders
Represents the Headers record for the operation: list-webhooks
Fields
smartsheet: ListWebhooksQueries
Represents the Queries record for the operation: list-webhooks
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ListWorkspaceSharesHeaders
Represents the Headers record for the operation: list-workspace-shares
Fields
smartsheet: ListWorkspaceSharesQueries
Represents the Queries record for the operation: list-workspace-shares
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ListWorkspacesHeaders
Represents the Headers record for the operation: list-workspaces
Fields
smartsheet: ListWorkspacesQueries
Represents the Queries record for the operation: list-workspaces
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: MiniUser
MiniUser Object
Fields
- name? string - User's full name
- email? string - User's email address
smartsheet: MoveFolderHeaders
Represents the Headers record for the operation: move-folder
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: MoveRowsHeaders
Represents the Headers record for the operation: move-rows
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: MoveRowsQueries
Represents the Queries record for the operation: move-rows
Fields
- include? "attachments"|"discussions" - A comma-separate list of row elements to move in addition to the cell data
- ignoreRowsNotFound boolean(default false) - true or false: default is false. If set to true, specifying row Ids that do not exist within the source sheet does not cause an error response. If omitted or set to false, specifying row Ids that do not exist within the source sheet causes an error response (and no rows are moved)
smartsheet: MoveSheetHeaders
Represents the Headers record for the operation: move-sheet
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: MoveSightHeaders
Represents the Headers record for the operation: move-sight
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: MultiContactObjectValue
Fields
- value? ContactObjectValue[] - List of Contacts
- objectType? "MULTI_CONTACT" - Object containing a list of Contacts
smartsheet: MultiPicklistObjectValue
Object containing a list of strings to choose from
Fields
- values? string[] - List of strings to choose from
- objectType? "MULTI_PICKLIST" - Type of this object, always set to 'MULTI_PICKLIST'
smartsheet: OAuth2RefreshTokenGrantConfig
Closed record
OAuth2 Refresh Token Grant Configs
Fields
- refreshUrl string(default "https://api.smartsheet.com/2.0/token") - Refresh URL
smartsheet: Predecessor
Fields
- lag? Duration - In a project sheet, represents a value in a duration cell, or a lag value of a predecessor
- inCriticalPath? boolean - True if this predecessor is in the critical path
- invalid? boolean - True if the row referenced by rowId is not a valid row in this sheet, or there is a circular reference (displayed in the Smartsheet app as "#REF") Omitted if false
- 'type? "FF"|"FS"|"SF"|"SS" - Type of the predecessor:
- FF (Finish-to-Finish) - finish at the same time the predecessor finishes.
- FS (Finish-to-Start) - start after the predecessor finishes.
- SF (Start-to-Finish) - finish before the predecessor starts.
- SS (Start-to-Start) - start at the same time the predecessor starts
- rowNumber? decimal - The row number of the predecessor row. Omitted if invalid is true
- rowId? decimal - The Id of the predecessor row
smartsheet: PredecessorList
Object containing a list of references to rows on which the current row depends
Fields
- predecessors? Predecessor[] - List of references to rows on which the current row depends
- objectType? "PREDECESSOR_LIST" - Indicates the type of the object. For PredecessorList, this will always be 'PREDECESSOR_LIST'
smartsheet: ProfileImage
Represents a user's profile image including its unique ID, width, and height
Fields
- imageId? string - Unique image Id
- width? string - Image width
- height? string - Image height
smartsheet: ProjectSettings
Represents the project settings dependencies for a specific sheet. Project settings may be updated on sheets that the user has editor access
Fields
- nonWorkingDays? string[] - Non-working days for a project sheet
- workingDays? ("MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY")[] - Working days for a project sheet
- lengthOfDay? decimal - Length of a workday for a project sheet
smartsheet: PromoteAlternateEmailHeaders
Represents the Headers record for the operation: promote-alternate-email
Fields
smartsheet: Proof
Object containing zero or more media items, including images, videos, and documents, for review, editing, or approval
Fields
- lastUpdatedBy? MiniUser -
Userobject containingnameandemailof the user who last updated the proof
- attachments? Attachment[] - Array of Attachment objects. Only returned if the include query string parameter contains attachments
- lastUpdatedAt? Timestamp - The date and time when the proof was last updated
- proofType? "DOCUMENT"|"IMAGE"|"MIXED"|"NONE"|"VIDEO" - File type for the proof version
- name? string - Proof name. This is the same as primary column value. If the primary column value is empty, name is empty
- discussions? Discussion[] - Array of Discussion objects. Only returned if the include query string parameter contains discussions
- id? decimal - Proof Id of the proof version
- originalId? decimal - Proof Id of the original proof version
- proofRequestUrl? string - URL to review a proofing request
- version? decimal - The version number of the proof
- isCompleted? boolean - Indicates whether the proof is completed
smartsheet: ProofAttachmentListData
Fields
- data? Attachment[] - list of proof attachments
smartsheet: ProofAttachmentListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *ProofAttachmentListData
- data Attachment[]
- anydata...
smartsheet: ProofDetailListData
Fields
- data? Proof[] - list of all proofs
smartsheet: ProofDetailListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *ProofDetailListData
- data Proof[]
- anydata...
smartsheet: ProofDiscussionListData
Fields
- data? Discussion[] - list of proof discussions
smartsheet: ProofDiscussionListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *ProofDiscussionListData
- data Discussion[]
- anydata...
smartsheet: ProofListData
Fields
- result? Comment -
smartsheet: ProofListResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *ProofListData
- result Comment
- anydata...
smartsheet: ProofRequestAction
Fields
- actionStatus? "APPROVED"|"PENDING"|"REJECTED" - Proof request action status
- user? MiniUser -
Userobject containingnameandemailof the user performing the action
smartsheet: ProofRequestActionListData
Fields
- data? ProofRequestAction[] - list of proof request actions
smartsheet: ProofRequestActionListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *ProofRequestActionListData
- data ProofRequestAction[]
- anydata...
smartsheet: ProofRequestCreateData
Fields
- result? ProofRequest -
smartsheet: ProofRequestCreateResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *ProofRequestCreateData
- result ProofRequest
- anydata...
smartsheet: ProofsAttachToProofHeaders
Represents the Headers record for the operation: proofs-attachToProof
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: ProofsCreateDiscussionHeaders
Represents the Headers record for the operation: proofs-createDiscussion
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: ProofsCreateHeaders
Represents the Headers record for the operation: proofs-create
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: ProofsCreateProofRequestsHeaders
Represents the Headers record for the operation: proofs-createProofRequests
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: ProofsCreateVersionHeaders
Represents the Headers record for the operation: proofs-createVersion
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: ProofsDeleteHeaders
Represents the Headers record for the operation: proofs-delete
Fields
smartsheet: ProofsDeleteProofRequestsHeaders
Represents the Headers record for the operation: proofs-deleteProofRequests
Fields
smartsheet: ProofsDeleteVersionHeaders
Represents the Headers record for the operation: proofs-deleteVersion
Fields
smartsheet: ProofsGetAllProofsHeaders
Represents the Headers record for the operation: proofs-getAllProofs
Fields
smartsheet: ProofsGetAllProofsQueries
Represents the Queries record for the operation: proofs-getAllProofs
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ProofsGetHeaders
Represents the Headers record for the operation: proofs-get
Fields
smartsheet: ProofsGetQueries
Represents the Queries record for the operation: proofs-get
Fields
- include? "attachments"|"discussions" - A comma-separated list of optional elements to include in the response
smartsheet: ProofsGetVersionsHeaders
Represents the Headers record for the operation: proofs-getVersions
Fields
smartsheet: ProofsGetVersionsQueries
Represents the Queries record for the operation: proofs-getVersions
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ProofsListAttachmentsHeaders
Represents the Headers record for the operation: proofs-listAttachments
Fields
smartsheet: ProofsListAttachmentsQueries
Represents the Queries record for the operation: proofs-listAttachments
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ProofsListDiscussionsHeaders
Represents the Headers record for the operation: proofs-listDiscussions
Fields
smartsheet: ProofsListDiscussionsQueries
Represents the Queries record for the operation: proofs-listDiscussions
Fields
- include? "attachments"|"comments" - A comma-separated list of optional elements to include in the response:
- attachments - effective only if comments is present, otherwise ignored
- comments - include all comments in threads
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ProofsListRequestActionsHeaders
Represents the Headers record for the operation: proofs-listRequestActions
Fields
smartsheet: ProofsListRequestActionsQueries
Represents the Queries record for the operation: proofs-listRequestActions
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ProofsUpdateHeaders
Represents the Headers record for the operation: proofs-update
Fields
smartsheet: ProofVersionListData
Fields
- data? Proof[] - list of proof versions
smartsheet: ProofVersionListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *ProofVersionListData
- data Proof[]
- anydata...
smartsheet: ProofVersionResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- result? Proof - Object containing zero or more media items, including images, videos, and documents, for review, editing, or approval
smartsheet: PublicTemplateListData
Fields
- result? Share[] -
smartsheet: PublicTemplateListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *PublicTemplateListData
- result Share[]
- anydata...
smartsheet: ReactivateUserHeaders
Represents the Headers record for the operation: reactivate-user
Fields
smartsheet: RecipientGroup
Specifies the recipient of an Email. The recipient may be either an individual or a group. To specify an individual, set the email attribute; to specify a group, set the groupId attribute. Either email and groupId may be set, but not both
Fields
- groupId? decimal - The Id of a group recipient
smartsheet: RecipientIndividual
Specifies the recipient of an Email. The recipient may be either an individual or a group. To specify an individual, set the email attribute; to specify a group, set the groupId attribute. Either email and groupId may be set, but not both
Fields
- email? string - The email address of an individual recipient
smartsheet: RemoveUserHeaders
Represents the Headers record for the operation: remove-user
Fields
smartsheet: RemoveUserQueries
Represents the Queries record for the operation: remove-user
Fields
- removeFromSharing boolean(default false) - If you're removing the user from your organization, set this to
trueto remove the user's access to all assets in your organization and plan. If you're removing the user from your plan, this parameter is ignored and the user's access to all assets in your organization and plan is removed automatically
- transferSheets boolean(default false) - If you're removing the user from your organization and you want to transfer ownership of all the removed user's assets and groups to a qualified user*, set this parameter to
trueand set thetransferToparameter to the ID of the qualified user. The transfer depends on setting thetransferToparameter. If you're removing the user from your plan, this parameter is ignored. Warning: If your asset transfer size exceeds 38k, the transfer fails with a400error that prompts you to contact Support for guidance. *The receiving user must be a <a href="https://help.smartsheet.com/articles/520100-user-types" target="_blank" rel="noopener noreferrer">Group Admin</a> of the group(s) to be transferred
- transferTo? int - Set this to the ID of a qualified user* to receive ownership of all groups the removed user owns.
If you're removing the user from your organization and you set the
transferSheetsparameter totrue, the operation additionally transfers ownership of all the removed user's assets to the assigned user. If you're removing the user from your plan and you don't set this parameter, the operation transfers group ownership to the respective main contact of each group's organization. *The receiving user must be a <a href="https://help.smartsheet.com/articles/520100-user-types" target="_blank" rel="noopener noreferrer">Group Admin</a> of the groups
smartsheet: ReportAddShare
Fields
- Fields Included from *Event
- action? "ADD_SHARE" - The action applied to the specified object
- additionalDetails? ReportAddShareAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportAddShareAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- accessLevel? "VIEWER"|"EDITOR"|"EDITOR_SHARE"|"ADMIN" - Indicates the access level granted to the group or user. Note that this access level represents the access level granted by this specific sharing action; it is not the group or user's effective access level for the report
- groupId? int - Id of the group that was added to the report's sharing list. (Specific to share to group actions)
- userId? int - Id of the user that was added to the report's sharing list. (Specific to share to user actions)
smartsheet: ReportAddShareMember
Fields
- Fields Included from *Event
- action? "ADD_SHARE_MEMBER" - The action applied to the specified object
- additionalDetails? ReportAddShareMemberAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportAddShareMemberAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- accessLevel? "VIEWER"|"EDITOR"|"EDITOR_SHARE"|"ADMIN" - Indicates the access level granted to the user. Note that this access level represents the access level that has been granted to the user via group membership; it is not the user's effective access level for the report
- groupId? int - Id of the group the user was added to
- userId? int - Id of the user that was added to the group
- workspaceId? int - Id of the workspace that the group is shared to. (Specific to cases where the report is shared to the group via a workspace's sharing list)
smartsheet: ReportAddWorkspaceShare
Fields
- Fields Included from *Event
- action? "ADD_WORKSPACE_SHARE" - The action applied to the specified object
- additionalDetails? ReportAddWorkspaceShareAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportAddWorkspaceShareAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- accessLevel? "VIEWER"|"EDITOR"|"EDITOR_SHARE"|"ADMIN" - Indicates the access level granted to the group or user. Note that this access level represents the access level granted by this specific sharing action; it is not the group or user's effective access level for the report
- groupId? int - Id of the group that the workspace was shared to. (Specific to share to group actions)
- userId? int - Id of the user that the workspace was shared to. (Specific to share to user actions)
- workspaceId? int - Id of the workspace that was shared to the group or user
smartsheet: ReportCreate
Fields
- Fields Included from *Event
- action? "CREATE" - The action applied to the specified object
- additionalDetails? ReportCreateAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportCreateAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- reportName? string - Name of the new report
- sourceType? "report"|"globale_template" - Type of object used to create the new report
- sourceObjectId? int - Id of report that was copied to create the new report. (Only included if the report was created as a result of a copy or save as new)
- sourceGlobalTemplateId? int - Id of the global template that was used to create the new report (Only included if the report was created using a global template. "New Blank Report" is a global template)
smartsheet: ReportDelete
Fields
- Fields Included from *Event
- action? "DELETE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportExport
Fields
- Fields Included from *Event
- action? "EXPORT" - The action applied to the specified object
- additionalDetails? ReportExportAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportExportAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- formatType? "png_gantt"|"mspdi"|"excel"|"pdf" - The format that the report was exported in "png_gantt" (gantt image), "mspdi" (Microsoft Project), "excel", or "pdf"
smartsheet: ReportLoad
Fields
- Fields Included from *Event
- action? "LOAD" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportMove
Fields
- Fields Included from *Event
- action? "MOVE" - The action applied to the specified object
- additionalDetails? ReportMoveAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportMoveAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- parentContainerId? int - Id of the parent container of the report. (Specific to move events where a folder containing the report is moved to a folder in a different workspace, indicates that the report has moved to a new workspace but is still within the same folder)
- newParentContainerId? int - Id of the destination folder for the move event. (Specific to actions where the report was moved to a different folder)
- folderName? string - Name of the destination folder for the move event. (Specific to actions where the report was moved to a different folder)
- workspaceId? int - Id of the workspace the report is currently in. If the move was between two workspaces the
workspaceIdwill be the Id of the destination workspace
smartsheet: ReportPublish
Fields
- readOnlyFullUrl? string - URL for 'Read-Only Full' view of the published report. Only returned in a response if readOnlyFullEnabled = true
- readOnlyFullEnabled? boolean - (Required) If true, a rich version of the report is published with the ability to download row attachments and discussions
- readOnlyFullAccessibleBy? string - Indicates who can access the 'Read-Only Full' view of the published report:
- If ALL, it is available to anyone who has the link.
- If ORG, it is available only to members of the report owner's Smartsheet organization account.
- If SHARED, it is available only to users shared to the item.
- readOnlyFullShowToolbar? boolean - Deprecated Indicates whether the left nav toolbar is displayed. The default, or true, is to display the toolbar. If false, hides the toolbar
- readOnlyFullDefaultView? string - Indicates which view the user has set for a read-only, default view of the published report. Must be one of the following values: CALENDAR, CARD, or GRID
smartsheet: ReportPublishData
Fields
- result? ReportPublish -
smartsheet: ReportPublishResponse
Fields
- Fields Included from *ReportPublishData
- result ReportPublish
- anydata...
smartsheet: ReportPurge
Fields
- Fields Included from *Event
- action? "PURGE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportRemoveShare
Fields
- Fields Included from *Event
- action? "REMOVE_SHARE" - The action applied to the specified object
- additionalDetails? ReportRemoveShareAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportRemoveShareAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- groupId? int - Id of the group that was added to the report's sharing list. (Specific to share to group actions)
- userId? int - Id of the user that was added to the report's sharing list. (Specific to share to user actions)
smartsheet: ReportRemoveShareMember
Fields
- Fields Included from *Event
- action? "REMOVE_SHARE_MEMBER" - The action applied to the specified object
- additionalDetails? ReportRemoveShareMemberAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportRemoveShareMemberAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- groupId? int - Id of the group that the user was removed from
- userId? int - Id of user that was removed from the group
- workspaceId? int - Id of the workspace that the group is shared to. (Specific to cases where the report is shared to the group via a workspace's sharing list)
smartsheet: ReportRemoveWorkspaceShare
Fields
- Fields Included from *Event
- action? "REMOVE_WORKSPACE_SHARE" - The action applied to the specified object
- additionalDetails? DashboardRemoveWorkspaceShareAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportRename
Fields
- Fields Included from *Event
- action? "RENAME" - The action applied to the specified object
- additionalDetails? ReportRenameAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportRenameAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- newName? string - New name of the report
- oldName? string - Previous name of the report
smartsheet: ReportRestore
Fields
- Fields Included from *Event
- action? "RESTORE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportSaveAsNew
Fields
- Fields Included from *Event
- action? "SAVE_AS_NEW" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportSendAsAttachment
Fields
- Fields Included from *Event
- action? "SEND_AS_ATTACHMENT" - The action applied to the specified object
- additionalDetails? ReportSendAsAttachmentAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportSendAsAttachmentAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- recipientGroupId? int - Single ID of a user group explicitly included in the recipient list. (This property is included only if the
recipientEmailproperty above isn't included)
- formatType? "excel"|"pdf"|"pdf_gantt"|"pdf_calendar" - The format in which the report was sent
- recipientEmail? string - Single email address either of a user explicitly included in the recipient list or of the sender (when CC sender is requested). (This property is included only if the
recipientGroupIdproperty below isn't included)
smartsheet: ReportTransferOwnership
Fields
- Fields Included from *Event
- action? "TRANSFER_OWNERSHIP" - The action applied to the specified object
- additionalDetails? ReportTransferOwnershipAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ReportTransferOwnershipAdditionalDetails
Fields
- newAccessLevel "OWNER" (default "OWNER") - New access level of the new owner:
"OWNER"
- emailAddress string - Email address of the user responsible for the event
- newUserId? int - Id of the new owner
- oldUserId? int - Id of the former owner
- oldAccessLevel "ADMIN" (default "ADMIN") - New access level of the former owner:
"ADMIN"
smartsheet: ReportUpdate
Fields
- Fields Included from *Event
- action? "UPDATE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "REPORT" - The Smartsheet resource impacted by the event
smartsheet: ResetSharedSecretHeaders
Represents the Headers record for the operation: resetSharedSecret
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: Row
Fields
- conditionalFormat? string - Describes this row's conditional format. Only returned if the include query string parameter contains format and this row has a conditional format applied
- attachments? Attachment[] - Attachments on row. Only returned if the include query string parameter contains attachments
- permaLink? string - URL that represents a direct link to the row in Smartsheet. Only returned if the include query string parameter contains rowPermalink
- accessLevel? AccessLevel - Specifies the user's level of access or permissions, such as ADMIN, OWNER, EDITOR, or VIEWER
- columns? Column[] - Columns of row. Only returned if the include query string parameter contains columns
- modifiedAt? Timestamp -
- discussions? Discussion[] - Discussions on the row. Only returned if the include query string parameter contains discussions
- format? string - Format descriptor. Only returned if the include query string parameter contains format and this row has a non-default format applied
- version? decimal - Sheet version number that is incremented every time a sheet is modified
- createdAt? Timestamp -
- expanded? boolean - Indicates whether the row is expanded or collapsed
- cells? Cell[] - Cells belonging to the row
- createdBy? MiniUser - User object containing name and email of the creator of this row
- filteredOut? boolean - Indicates if the row is filtered out by a column filter. Only returned if the include query string parameter contains filters
- inCriticalPath? boolean - Only returned, with a value of true, if the sheet is a project sheet with dependencies enabled and this row is in the critical path
- sheetId? decimal - Parent sheet Id
- lockedForUser? boolean - Indicates whether the row is locked for the requesting user
- modifiedBy? MiniUser - User object containing name and email of the last person to modify this row
- id? decimal - Row Id
- proof? Proof - Object containing zero or more media items, including images, videos, and documents, for review, editing, or approval
- locked? boolean - Indicates whether the row is locked
- rowNumber? decimal - Row number within the sheet
- siblingId? decimal - Sibling Id
smartsheet: RowAttachmentListData
Fields
- data? CellHistory[] - List of cell history objects
smartsheet: RowAttachmentListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *RowAttachmentListData
- data CellHistory[]
- anydata...
smartsheet: RowAttachmentsAttachFileHeaders
Represents the Headers record for the operation: row-attachments-attachFile
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: RowCopyData
Fields
- result? UpdateRowsObject[] -
smartsheet: RowCopyResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *RowCopyData
- result UpdateRowsObject[]
- anydata...
smartsheet: RowCreateData
Fields
- result? Row -
smartsheet: RowCreateResponse
Fields
- Fields Included from *RowCreateData
- result Row
- anydata...
smartsheet: RowDiscussionsCreateHeaders
Represents the Headers record for the operation: row-discussions-create
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: RowDiscussionsListHeaders
Represents the Headers record for the operation: row-discussions-list
Fields
smartsheet: RowDiscussionsListQueries
Represents the Queries record for the operation: row-discussions-list
Fields
- include? "attachments"|"comments" - A comma-separated list of optional elements to include in the response:
- attachments - effective only if comments is present, otherwise ignored
- comments - include all comments in threads
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: RowGetHeaders
Represents the Headers record for the operation: row-get
Fields
smartsheet: RowGetQueries
Represents the Queries record for the operation: row-get
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- include? "columns"|"filters" - A comma-separated list of elements to include in the response. See Row Include Flags. Also supports the columns include flag, which adds a columns array that specifies all of the columns for the sheet. This enables you to have the full context of the cells in the row. The filters include flag returns a filteredOut attribute indicating if the row should be displayed or hidden according to the sheet's filters
- level int(default 0) - Specifies whether object data types, such as multi-contact data are returned in a backwards-compatible, text format in text/number columns.<br> - Set
level=0(default) to use text/number columns for multi-contact data and multi-picklist data.<br> - Setlevel=1to use multiple-entry contact list columns for multi-contact data; multi-picklist data is returned in text/number columns.<br> - Setlevel=2to use multiple-entry contact list columns for multi-contact data and use multiple-entry picklist columns for multi-picklist data
- exclude? "filteredOutRows"|"linkInFromCellDetails"|"linksOutToCellsDetails"|"nonexistentCells" - A comma-separated list of element types to exclude from the response:
- filteredOutRows - excludes filtered-out rows from response payload if a sheet filter is applied; includes total number of filtered rows
- linkInFromCellDetails - excludes the following attributes from the cell.linkInFromCell object:
columnId,rowId,status - linksOutToCellsDetails - excludes the following attributes from the cell.linksOutToCells array elements:
columnId,rowId,status - nonexistentCells - excludes empty cells
smartsheet: RowListData
Fields
- result? decimal[] -
smartsheet: RowListResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *RowListData
- result decimal[]
- anydata...
smartsheet: RowMapping
Fields
- 'from? decimal - Row Id in the source sheet
- to? decimal - Row Id in the destination sheet
smartsheet: RowMoveData
Fields
- result? AddRowsObject[] -
smartsheet: RowMoveResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *RowMoveData
- result AddRowsObject[]
- anydata...
smartsheet: RowsAddToSheetHeaders
Represents the Headers record for the operation: rows-addToSheet
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: RowsAddToSheetQueries
Represents the Queries record for the operation: rows-addToSheet
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- allowPartialSuccess boolean(default false) - When specified with a value of true, enables partial success for this bulk operation. See Bulk operations > Partial success for more information
- overrideValidation boolean(default false) - You may use the query string parameter overrideValidation with a value of true to allow a cell value outside of the validation limits. You must specify strict with a value of false to bypass value type checking
smartsheet: RowsSendHeaders
Represents the Headers record for the operation: rows-send
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: RowsSortHeaders
Represents the Headers record for the operation: rows-sort
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: RowsSortQueries
Represents the Queries record for the operation: rows-sort
Fields
smartsheet: Schedule
Fields
- dayOfMonth? decimal - The day within the month.
Valid range is 1 to 28.
This attribute is applicable to the following schedule type:
- MONTHLY
- dayDescriptors? ("DAY"|"WEEKDAY"|"WEEKEND"|"SUNDAY"|"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY")[] - A string array consists of one or more of the following values:
- DAY, WEEKDAY, WEEKEND
- SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
- dayOrdinal? "FIRST"|"LAST"|"SECOND"|"THIRD"|"FOURTH" - Must be one of the following values:
- FIRST or LAST
- SECOND, THIRD, or FOURTH
- MONTHLY
- lastSentAt? Timestamp -
- repeatEvery? decimal - Frequency on which the request is delivered. The unit is a function of the type attribute. For example, for MONTHLY schedule, repeatEvery=1 means every month. Valid range is 1 to 99. This attribute is applicable to the following schedule types: DAILY, WEEKLY, MONTHLY, or YEARLY. For more details, refer to the Table of Schedule Object’s Attributes below
- 'type? "ONCE"|"DAILY"|"WEEKLY"|"MONTHLY"|"YEARLY" - Type of schedule
- endAt? TimestampWriteable -
- nextSendAt? Timestamp -
- startAt? TimestampWriteable -
smartsheet: SchemasSheet
Fields
- createdAt? Timestamp -
- accessLevel? AccessLevel - Specifies the user's level of access or permissions, such as ADMIN, OWNER, EDITOR, or VIEWER
- modifiedAt? Timestamp -
- name? Name - Sheet name
- id? Id - Sheet Id
- 'source? Source -
- permalink? Permalink - URL that represents a direct link to the sheet in Smartsheet
- version? Version - A number that is incremented every time a sheet is modified
smartsheet: SearchResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *SearchResultData
- result Folder[]
- anydata...
smartsheet: SearchResult
Fields
- results? SearchResultItem[] - Array of SearchResultItem objects.
- totalCount? decimal - Total number of search results.
smartsheet: SearchResultData
Fields
- result? Folder[] -
smartsheet: SearchResultItem
Fields
- parentObjectName? string - Search result parent object name
- parentObjectId? decimal - Search result parent object Id
- parentObjectType? string - Search result parent object type (dashboard, folder, report, sheet, template, or workspace)
- text? string - Search result text excerpt
- objectId? decimal - Search result object Id
- contextData? string[] - Additional info about the search result item. If the item has a discussion or attachment belonging to a proof, the context data includes the URL of that proof (e.g., "proofUrl: https://app.smartsheet.com/b/proofs/sheets/abc123/proofs/def456")
- objectType? string - Search result object type (attachment, dashboard, discussion, folder, report, row, sheet, summaryField, template, or workspace)
smartsheet: SendReportViaEmailHeaders
Represents the Headers record for the operation: sendReportViaEmail
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: SentUpdateRequest
Fields
- sentTo? Recipient - Recipient object
- includeAttachments? boolean - Indicates whether the attachments were included in the email
- rowIds? decimal[] - The Ids of rows where an update is requested
- columnIds? decimal[] - The Ids of columns included in the request
- updateRequestId? decimal - The Id of the originating update request
- subject? string - The subject of the email
- id? decimal - The Id of the sent update request
- sentAt? Timestamp - The date and time for when the sent update request was sent to the recipient
- message? string - The message of the email. Max 10000 characters
- includeDiscussions? boolean - Indicates whether the discussions were included in the email
- sentBy? MiniUser -
Userobject containingnameandemailof the sender
- status? "CANCELED"|"COMPLETE"|"PENDING" - The status of the sent update request
smartsheet: SentupdaterequestDeleteHeaders
Represents the Headers record for the operation: sentupdaterequest-delete
Fields
smartsheet: SentupdaterequestGetHeaders
Represents the Headers record for the operation: sentupdaterequest-get
Fields
smartsheet: SentUpdateRequestListData
Fields
- data? SentUpdateRequest[] - list of Sent Update Requests
smartsheet: SentUpdateRequestListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *SentUpdateRequestListData
- data SentUpdateRequest[]
- anydata...
smartsheet: SentupdaterequestsListHeaders
Represents the Headers record for the operation: sentupdaterequests-list
Fields
smartsheet: SentupdaterequestsListQueries
Represents the Queries record for the operation: sentupdaterequests-list
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: ServerInfo
Fields
- formats? FormatTables - Contains all of the lookup tables that the format descriptor indexes refer to. Here the examples show the formatting options, the default value is used to denote each option. NOTE -- Indexes and their values are guaranteed never to change or be removed for a given major API version. However, new values could potentially be added to the ends of lookup tables. Because of this possibility, your code should handle the case where a cell might contain a format index value greater than the size of a lookup table your app has loaded. Your application should check for that case and reload the format tables if necessary
- supportedLocales? string[] - Array of strings representing all Smartsheet-supported locales
smartsheet: SetReportPublishHeaders
Represents the Headers record for the operation: SetReportPublish
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: SetSheetPublishHeaders
Represents the Headers record for the operation: set-sheetPublish
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: SetSightPublishStatusHeaders
Represents the Headers record for the operation: set-sight-publish-status
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: Share
Fields
- accessLevel? AccessLevel - Specifies the user's level of access or permissions, such as ADMIN, OWNER, EDITOR, or VIEWER
- modifiedAt? Timestamp -
- subject? string - The subject of the email that is optionally sent to notify the recipient. You can specify this attribute in a request, but it is never present in a response
- groupId? decimal - Group Id if the share is a group share, else null
- 'type? string - The type of this share. One of the following values: GROUP or USER
- message? string - The message included in the body of the email that is optionally sent to the recipient. You can specify this attribute in a request, but it is never present in a response
- userId? decimal - User Id if the share is a user share, else null
- createdAt? Timestamp -
- ccMe? boolean - Indicates whether to send a copy of the email to the sharer of the sheet. You can specify this attribute in a request, but it is never present in a response
- scope? string - The scope of this share. One of the following values:
- ITEM: an item-level share (that is, the specific object to which the share applies is shared with the user or group).
- WORKSPACE: a workspace-level share (that is, the workspace that contains the object to which the share applies is shared with the user or group)
- name? string - If a user share and user is also a contact, the user's full name. If a group share, the group's name
- id? string - Share Id. NOTE: unlike other Smartsheet object Ids, this Id is an alphanumeric string
- email? string - User's primary email address for user shares; null for group shares
smartsheet: ShareCreateData
Fields
- result? SightResult -
smartsheet: ShareCreateResponse
Fields
- Fields Included from *ShareCreateData
- result SightResult
- anydata...
smartsheet: ShareData
Fields
- result? Sight -
smartsheet: SharedSecret
Fields
smartsheet: SharedSecretData
Fields
- result? Folder -
smartsheet: SharedSecretResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *SharedSecretData
- result Folder
- anydata...
smartsheet: ShareReportGetHeaders
Represents the Headers record for the operation: share-report-get
Fields
smartsheet: ShareReportGetQueries
Represents the Queries record for the operation: share-report-get
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
smartsheet: ShareReportHeaders
Represents the Headers record for the operation: share-report
Fields
smartsheet: ShareReportQueries
Represents the Queries record for the operation: share-report
Fields
- sendEmail boolean(default false) - Either true or false to indicate whether to notify the user by email. Default is false. If true, limit is 1000 emails
smartsheet: ShareResponse
Fields
- Fields Included from *ShareData
- result Sight
- anydata...
smartsheet: ShareSheetGetHeaders
Represents the Headers record for the operation: share-sheet-get
Fields
smartsheet: ShareSheetGetQueries
Represents the Queries record for the operation: share-sheet-get
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
smartsheet: ShareSheetHeaders
Represents the Headers record for the operation: share-sheet
Fields
smartsheet: ShareSheetQueries
Represents the Queries record for the operation: share-sheet
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- sendEmail boolean(default false) - Either true or false to indicate whether to notify the user by email. Default is false. If true, limit is 1000 emails
smartsheet: ShareSightGetHeaders
Represents the Headers record for the operation: share-sight-get
Fields
smartsheet: ShareSightGetQueries
Represents the Queries record for the operation: share-sight-get
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
smartsheet: ShareSightHeaders
Represents the Headers record for the operation: share-sight
Fields
smartsheet: ShareSightQueries
Represents the Queries record for the operation: share-sight
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- sendEmail boolean(default false) - Either true or false to indicate whether to notify the user by email. Default is false. If true, limit is 1000 emails
smartsheet: SharesshareIdBody
Fields
- accessLevel? AccessLevel - Specifies the user's level of access or permissions, such as ADMIN, OWNER, EDITOR, or VIEWER
smartsheet: ShareUpdateData
Fields
- result? SightPublish - Describes the dashboard's publish settings
smartsheet: ShareUpdateResponse
Fields
- Fields Included from *ShareUpdateData
- result SightPublish
- anydata...
smartsheet: ShareWorkspaceGetHeaders
Represents the Headers record for the operation: share-workspace-get
Fields
smartsheet: ShareWorkspaceGetQueries
Represents the Queries record for the operation: share-workspace-get
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
smartsheet: ShareWorkspaceHeaders
Represents the Headers record for the operation: share-workspace
Fields
smartsheet: ShareWorkspaceQueries
Represents the Queries record for the operation: share-workspace
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- sendEmail boolean(default false) - Either true or false to indicate whether to notify the user by email. Default is false. If true, limit is 1000 emails
smartsheet: Sheet
Fields
- isMultiPicklistEnabled? boolean - Indicates whether multi-select is enabled
- workspace? WorkspaceListing -
- attachments? Attachment[] - Array of Attachment objects. Only returned if the include query string parameter contains attachments
- columns? Column[] -
- modifiedAt? Timestamp -
- discussions? Discussion[] - Array of Discussion objects Only returned if the include query string parameter contains discussions
- 'source? Source -
- userPermissions? SheetUserPermissions - Describes the current user's editing permissions for a specific sheet
- ownerId? decimal - User Id of the sheet owner
- resourceManagementEnabled? boolean - Indicates that resource management is enabled
- cellImageUploadEnabled? boolean - The sheet is enabled for cell images to be uploaded
- hasSummaryFields? boolean - Indicates whether a sheet summary is present
- ganttEnabled? boolean - Indicates whether "Gantt View" is enabled
- createdAt? Timestamp -
- resourceManagementType? "NONE"|"LEGACY_RESOURCE_MANAGEMENT"|"RESOURCE_MANAGEMENT_BY_SMARTSHEET" - Resource Management type. Indicates the type of RM that is enabled
- id? decimal - Sheet Id
- totalRowCount? decimal - The total number of rows in the sheet
- owner? string - Email address of the sheet owner
- summary? SheetSummary - Represents the entire summary, or a list of defined fields and values, for a specific sheet
- accessLevel? AccessLevel - Specifies the user's level of access or permissions, such as ADMIN, OWNER, EDITOR, or VIEWER
- readOnly? boolean - Returned only if the sheet belongs to an expired trial (value = true)
- rows? Row[] -
- fromId? decimal - The Id of the template from which to create the sheet. This attribute can be specified in a request, but is never present in a response
- version? decimal - A number that is incremented every time a sheet is modified
- effectiveAttachmentOptions? string[] - Array of enum strings (see Attachment.attachmentType indicating the allowable attachment options for the current user and sheet
- dependenciesEnabled? boolean - Indicates whether dependencies are enabled
- showParentRowsForFilters? boolean - Returned only if there are column filters on the sheet. Value = true if "show parent rows" is enabled for the filters
- userSettings? SheetUserSettings - Represents individual user settings for a specific sheet. User settings may be updated even on sheets where the current user only has read access (for example, viewer permissions or a read-only sheet)
- crossSheetReferences? CrossSheetReference[] - Array of CrossSheetReference objects. Only returned if the include query string parameter contains crossSheetReferences
- name? string - Sheet name
- permalink? string - URL that represents a direct link to the sheet in Smartsheet
- favorite? boolean - Deprecated Returned only if the user has marked this sheet as a favorite in their Home tab (value = true)
- projectSettings? ProjectSettings - Represents the project settings dependencies for a specific sheet. Project settings may be updated on sheets that the user has editor access
smartsheet: SheetAddShare
Fields
- Fields Included from *Event
- action? "ADD_SHARE" - The action applied to the specified object
- additionalDetails? SheetAddShareAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetAddShareAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- accessLevel? "VIEWER"|"EDITOR"|"EDITOR_SHARE"|"ADMIN" - Indicates the access level granted to the group or user. Note that this access level represents the access level granted by this specific sharing action; it is not the group or user's effective access level for the sheet
- groupId? int - Id of the group that was added to the sheet's sharing list. (Specific to share to group actions)
- userId? int - Id of the user that was added to the sheet's sharing list. (Specific to share to user actions)
smartsheet: SheetAddShareMember
Fields
- Fields Included from *Event
- action? "ADD_SHARE_MEMBER" - The action applied to the specified object
- additionalDetails? SheetAddShareMemberAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetAddShareMemberAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- accessLevel? "VIEWER"|"EDITOR"|"EDITOR_SHARE"|"ADMIN" - Indicates the access level granted to the user. Note that this access level represents the access level that has been granted to the user via group membership; it is not the user's effective access level for the sheet
- groupId? int - Id of the group the user was added to
- userId? int - Id of the user that was added to the group
- workspaceId? int - Id of the workspace that the group is shared to. (Specific to cases where the sheet is shared to the group via a workspace's sharing list)
smartsheet: SheetAddWorkspaceShare
Fields
- Fields Included from *Event
- action? "ADD_WORKSPACE_SHARE" - The action applied to the specified object
- additionalDetails? SheetAddWorkspaceShareAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetAddWorkspaceShareAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- accessLevel? "VIEWER"|"EDITOR"|"EDITOR_SHARE"|"ADMIN" - Indicates the access level granted to the group or user. Note that this access level represents the access level granted by this specific sharing action; it is not the group or user's effective access level for the sheet
- groupId? int - Id of the group that the workspace was shared to. (Specific to share to group actions)
- userId? int - Id of the user that the workspace was shared to. (Specific to share to user actions)
- workspaceId? int - Id of the workspace that was shared to the group or user
smartsheet: SheetCopyRow
Fields
- Fields Included from *Event
- action? "COPY_ROW" - The action applied to the specified object
- additionalDetails? SheetCopyRowAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetCopyRowAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- rowsCopied? int - Number of rows copied
- includeAttachments? boolean - Indicates whether the row(s) were copied with their respective attachments
- sourceSheetId? int - Id of sheet from where the rows copied. (Only included when the
objectIdproperty contains the Id of the destination sheet)
- destinationSheetId? int - Id of sheet to where the rows copied. (Only included when the
objectIdproperty contains the Id of the source sheet)
- includeDiscussions? boolean - Indicates whether the row(s) were copied with their respective discussion comments
smartsheet: SheetCreate
Fields
- Fields Included from *Event
- action? "CREATE" - The action applied to the specified object
- additionalDetails? SheetCreateAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetCreateAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- sheetName? string - Name of the newly created Sheets
- sourceType? "sheet"|"template"|"globale_template"|"import" -
- sourceTemplateId? int - Id of the template used to create the sheet. (Only included if the sheet was created using a template, that is not a global template)
- sourceObjectId? int - Id of sheet that was copied to create the new sheet. (Only included if the sheet was created as a result of a copy or save as new)
- sourceGlobalTemplateId? int - Id of the global template that was used to create the new sheet (Only included if the sheet was created using a global template)
smartsheet: SheetCreateCellLink
Fields
- Fields Included from *Event
- action? "CREATE_CELL_LINK" - The action applied to the specified object
- additionalDetails? SheetCreateCellLinkAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetCreateCellLinkAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- cellLinkSourceSheetId? int - Id of sheet referenced by the cell link
smartsheet: SheetCreated
Sheet created from scratch using the specified columns
Fields
- accessLevel? AccessLevel - Specifies the user's level of access or permissions, such as ADMIN, OWNER, EDITOR, or VIEWER
- columns? Columns - An array of Column objects, each defining the properties and configuration of a column in a sheet. See the Column schema for details on individual column attributes
- name? Name - Sheet name
- id? Id - Sheet Id
- permalink? Permalink - URL that represents a direct link to the sheet in Smartsheet
smartsheet: SheetCreatedFromTemplate
Sheet created from template
Fields
- accessLevel? AccessLevel - Specifies the user's level of access or permissions, such as ADMIN, OWNER, EDITOR, or VIEWER
- name? Name - Sheet name
- id? Id - Sheet Id
- permalink? Permalink - URL that represents a direct link to the sheet in Smartsheet
smartsheet: SheetDelete
Fields
- Fields Included from *Event
- action? "DELETE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetExport
Fields
- Fields Included from *Event
- action? "EXPORT" - The action applied to the specified object
- additionalDetails? SheetExportAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetExportAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- formatType? "png_gantt"|"mspdi"|"excel"|"pdf" - The format that the sheet was exported in "png_gantt" (gantt image), "mspdi" (Microsoft Project), "excel", or "pdf"
smartsheet: SheetImported
Sheet imported from CSV / XLSX file
Fields
- accessLevel? AccessLevel - Specifies the user's level of access or permissions, such as ADMIN, OWNER, EDITOR, or VIEWER
- name? Name - Sheet name
- id? Id - Sheet Id
- 'type? string - Container type. Has 'sheet' value for the imported sheet
- permalink? Permalink - URL that represents a direct link to the sheet in Smartsheet
smartsheet: SheetList
Fields
- owner? string - Empty string
- name? string - Sheet name
- id? decimal - Sheet Id
- ownerId? decimal - Set to a static value of "0"
smartsheet: SheetLoad
Fields
- Fields Included from *Event
- action? "LOAD" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetMove
Fields
- Fields Included from *Event
- action? "MOVE" - The action applied to the specified object
- additionalDetails? SheetMoveAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetMoveAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- parentContainerId? int - Id of the parent container of the sheet. (Specific to move events where a folder containing the sheet is moved to a folder in a different workspace, indicates that the sheet has moved to a new workspace but is still within the same folder)
- newParentContainerId? int - Id of the destination folder for the move event. (Specific to actions where the sheet was moved to a different folder)
- folderName? string - Name of the destination folder for the move event. (Specific to actions where the sheet was moved to a different folder)
- workspaceId? int - Id of the workspace the sheet is currently in. If the move was between two workspaces the
workspaceIdwill be the Id of the destination workspace
smartsheet: SheetMoveRow
Fields
- Fields Included from *Event
- action? "MOVE_ROW" - The action applied to the specified object
- additionalDetails? SheetMoveRowAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetMoveRowAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- includeAttachments? boolean - Indicates whether the row(s) were moved with their respective attachments
- sourceSheetId? int - Id of sheet from where the rows moved. (Only included when the
objectIdproperty contains the Id of the destination sheet)
- rowsMoved? int - Number of rows moved
- destinationSheetId? int - Id of sheet to where the rows moved. (Only included when the
objectIdproperty contains the Id of the source sheet)
- includeDiscussions? boolean - Indicates whether the row(s) were moved with their respective discussion comments
smartsheet: SheetPublish
Describes the sheet's publish settings
Fields
- readWriteDefaultView? "CALENDAR"|"CARD"|"GRID" - Indicates which view the user has set for a read-write, default view of the published sheet. Must be one of the listed enum values
- readOnlyFullAccessibleBy? "ALL"|"ORG"|"SHARED" - Indicates who can access the 'Read-Only Full' view of the published sheet:
- ALL - available to anyone who has the link.
- ORG - available only to members of the sheet owner's Smartsheet organization account.
- SHARED - available only to users shared to the item.
- readWriteEnabled? boolean - If true,a rich version of the sheet is published with the ability to edit cells and manage attachments and discussions
- icalUrl? anydata - URL for iCal view of the published sheet. Only returned in a response if icalEnabled = true
- readOnlyFullDefaultView? "CALENDAR"|"CARD"|"GRID" - Indicates which view the user has set for a read-only, default view of the published sheet. Must be one of the listed enum values
- readWriteShowToolbar? boolean - Deprecated Indicates whether the left nav toolbar is displayed. The default, or true, is to display the toolbar. If false, hides the toolbar
- readOnlyFullUrl? string - URL for 'Read-Only Full' view of the published sheet. Only returned in a response if **readOnlyFullEnabled = true
- icalEnabled? boolean - If true, a webcal is available for the calendar in the sheet
- readOnlyFullEnabled? boolean - If true, a rich version of the sheet is published with the ability to download row attachments and discussions
- readWriteUrl? string - URL for 'Edit by Anyone' view of the published sheet. Only returned in a response if readWriteEnabled = true
- readOnlyLiteSslUrl? string - URL for 'Read-Only' view of the published sheet when SSL is enabled
- readOnlyLiteUrl? string - URL for 'Read-Only HTML' view of the published sheet. Only returned in a response if readOnlyLiteEnabled = true
- readOnlyLiteEnabled? boolean - If true, a lightweight version of the sheet is published without row attachments and discussions
- readOnlyFullShowToolbar? boolean - Deprecated Indicates whether the left nav toolbar is displayed. The default, or true, is to display the toolbar. If false, hides the toolbar
- readWriteAccessibleBy? "ALL"|"ORG"|"SHARED" - Indicates who can access the 'Edit by Anyone' view of the published sheet:
- ALL - available to anyone who has the link.
- ORG - available only to members of the sheet owner's Smartsheet organization account.
- SHARED - available only to users shared to the item.
smartsheet: SheetPublishData
Fields
- result? SheetPublish - Describes the sheet's publish settings
smartsheet: SheetPublishRequest
Describes the sheet's publish settings. Used as a request body to set publish status
Fields
- readWriteDefaultView? ReadWriteDefaultView - Indicates which view the user has set for a read-write, default view of the published sheet. Must be one of the listed enum values
- icalEnabled? IcalEnabled - If true, a webcal is available for the calendar in the sheet
- readOnlyFullEnabled? ReadOnlyFullEnabled - If true, a rich version of the sheet is published with the ability to download row attachments and discussions
- readOnlyFullAccessibleBy? ReadOnlyFullAccessibleBy - Indicates who can access the 'Read-Only Full' view of the published sheet:
- ALL - available to anyone who has the link.
- ORG - available only to members of the sheet owner's Smartsheet organization account.
- SHARED - available only to users shared to the item.
- readOnlyLiteEnabled? ReadOnlyLiteEnabled - If true, a lightweight version of the sheet is published without row attachments and discussions
- readOnlyFullShowToolbar? ReadOnlyFullShowToolbar - Deprecated Indicates whether the left nav toolbar is displayed. The default, or true, is to display the toolbar. If false, hides the toolbar
- readWriteEnabled? ReadWriteEnabled - If true,a rich version of the sheet is published with the ability to edit cells and manage attachments and discussions
- readOnlyFullDefaultView? ReadOnlyFullDefaultView - Indicates which view the user has set for a read-only, default view of the published sheet. Must be one of the listed enum values
- readWriteAccessibleBy? ReadWriteAccessibleBy - Indicates who can access the 'Edit by Anyone' view of the published sheet:
- ALL - available to anyone who has the link.
- ORG - available only to members of the sheet owner's Smartsheet organization account.
- SHARED - available only to users shared to the item.
- readWriteShowToolbar? ReadWriteShowToolbar - Deprecated Indicates whether the left nav toolbar is displayed. The default, or true, is to display the toolbar. If false, hides the toolbar
smartsheet: SheetPublishResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *SheetPublishData
- result SheetPublish
- anydata...
smartsheet: SheetPurge
Fields
- Fields Included from *Event
- action? "PURGE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetRemoveShare
Fields
- Fields Included from *Event
- action? "REMOVE_SHARE" - The action applied to the specified object
- additionalDetails? SheetRemoveShareAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetRemoveShareAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- groupId? int - Id of the group that was removed from the sheet's sharing list. (Specific to remove share from group actions)
- userId? int - Id of the user that was removed from the sheet's sharing list. (Specific to remove share from user actions)
smartsheet: SheetRemoveShareMember
Fields
- Fields Included from *Event
- action? "REMOVE_SHARE_MEMBER" - The action applied to the specified object
- additionalDetails? SheetRemoveShareMemberAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetRemoveShareMemberAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- groupId? int - Id of the group that the user was removed from
- userId? int - Id of user that was removed from the group
- workspaceId? int - Id of the workspace that the group is shared to. (Specific to cases where the sheet is shared to the group via a workspace's sharing list)
smartsheet: SheetRemoveWorkspaceShare
Fields
- Fields Included from *Event
- action? "REMOVE_WORKSPACE_SHARE" - The action applied to the specified object
- additionalDetails? DashboardRemoveWorkspaceShareAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetRename
Fields
- Fields Included from *Event
- action? "RENAME" - The action applied to the specified object
- additionalDetails? SheetRenameAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetRenameAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- newName? string - New name of the sheet
- oldName? string - Previous name of the sheet
smartsheet: SheetRequestBackup
Fields
- Fields Included from *Event
- action? "REQUEST_BACKUP" - The action applied to the specified object
- additionalDetails? FolderRequestBackupAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetRestore
Fields
- Fields Included from *Event
- action? "RESTORE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetSaveAsNew
Fields
- Fields Included from *Event
- action? "SAVE_AS_NEW" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetSaveAsTemplate
Fields
- Fields Included from *Event
- action? "SAVE_AS_TEMPLATE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetSendAsAttachment
Fields
- Fields Included from *Event
- action? "SEND_AS_ATTACHMENT" - The action applied to the specified object
- additionalDetails? SheetSendAsAttachmentAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetSendAsAttachmentAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- recipientGroupId? int - Single ID of a user group explicitly included in the recipient list. (This property is included only if the
recipientEmailproperty above isn't included)
- formatType? "excel"|"pdf"|"pdf_gantt"|"pdf_calendar" - The format in which the sheet was sent
- recipientEmail? string - Single email address either of a user explicitly included in the recipient list or of the sender (when CC sender is requested). (This property is included only if the
recipientGroupIdproperty below isn't included)
smartsheet: SheetSendHeaders
Represents the Headers record for the operation: sheet-send
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: SheetSendRow
Fields
- Fields Included from *Event
- action? "SEND_ROW" - The action applied to the specified object
- additionalDetails? SheetSendRowAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetSendRowAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- includeAttachments? boolean - Indicates whether the row(s) were sent with their respective attachments
- rowCount? int - Number of rows sent
- recipientGroupId? int - Single ID of a user group explicitly included in the recipient list. (This property is included only if the
recipientEmailproperty above isn't included)
- recipientEmail? string - Single email address either of a user explicitly included in the recipient list or of the sender (when CC sender is requested). (This property is included only if the
recipientGroupIdproperty below isn't included)
- includeDiscussions? boolean - Indicates whether the row(s) were sent with their respective discussion comments
smartsheet: SheetSummary
Represents the entire summary, or a list of defined fields and values, for a specific sheet
Fields
- fields? SummaryField[] - Array of summary (or metadata) fields defined on the sheet
smartsheet: SheetToCreate
Sheet to create from scratch using the specified columns
Fields
- columns? ColumnToCreateASheet[] - List of columns to include in the new sheet
- name? Name - Sheet name
smartsheet: SheetToCreateFromTemplate
Sheet to create from template
Fields
- name? Name - Sheet name
- fromId? decimal - Template Id from which to create the sheet
smartsheet: SheetTransferOwnership
Fields
- Fields Included from *Event
- action? "TRANSFER_OWNERSHIP" - The action applied to the specified object
- additionalDetails? ReportTransferOwnershipAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetUpdate
Fields
- Fields Included from *Event
- action? "UPDATE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "SHEET" - The Smartsheet resource impacted by the event
smartsheet: SheetUserPermissions
Describes the current user's editing permissions for a specific sheet
Fields
- summaryPermissions? "ADMIN"|"READ_DELETE"|"READ_ONLY"|"READ_WRITE" - One of:
- ADMIN: full control over fields.
- READ_DELETE: sheet is owned by an individual account that doesn't have summary capabilities. If a summary exists, the only possible operations are GET and DELETE fields.
- READ_ONLY.
- READ_WRITE: can edit values of existing fields, but not create or delete fields, nor modify field type
smartsheet: SheetUserSettings
Represents individual user settings for a specific sheet. User settings may be updated even on sheets where the current user only has read access (for example, viewer permissions or a read-only sheet)
Fields
- criticalPathEnabled? boolean - Does this user have "Show Critical Path" turned on for this sheet? NOTE: This setting only has an effect on project sheets with dependencies enabled
- displaySummaryTasks? boolean - Does this user have "Display Summary Tasks" turned on for this sheet? Applies only to sheets where "Calendar View" has been configured
smartsheet: SheetVersion
Fields
- version? decimal - A number that represents the current sheet version
smartsheet: SightName
Fields
- name? string - Dashboard name
smartsheet: SightPublish
Describes the dashboard's publish settings
Fields
- readOnlyFullUrl? string - URL for 'Read-Only Full' view of the published dashboard. Only returned in a response if readOnlyFullEnabled = true
- readOnlyFullEnabled boolean - If true, a rich version of the dashboard is published with the ability to use shortcuts and widget interactions
- readOnlyFullAccessibleBy? "ALL"|"ORG" - Indicates who can access the 'Read-Only Full' view of the published dashboard. Only returned in the response if readOnlyFullEnabled = true.
- ALL - available to anyone who has the link.
- ORG - available only to members of the dashboard owner's Smartsheet organization account.
- SHARED - available only to users shared to the item.
If readOnlyFullEnabled is set to true in the request, but readOnlyFullAccessibleBy is not specified, the value of readOnlyFullAccessibleBy defaults to the organization-level 'Dashboard Publishing' setting (if the dashboard owner belongs to an organization account) or to ALL (if the dashboard owner does not belong to an organization account)
smartsheet: SortCriterion
Fields
- columnId? decimal -
- direction "ASCENDING"|"DESCENDING" (default "ASCENDING") - Direction of the sort
smartsheet: SortSpecifier
Fields
- sortCriteria? SortCriterion[] - Specifies sort order. Array is in priority order
smartsheet: Source
Fields
- id? decimal - The Id of the dashboard, report, sheet, or template from which the enclosing dashboard, report, sheet, or template was created
- 'type? string - report, sheet, sight (aka dashboard), or template
smartsheet: StreamResult
Stream result properties
Fields
- moreAvailable? boolean - True if more results are available. This is typically due to event counts exceeding the maxCount parameter passed in
- nextStreamPosition? string - This string should be passed back to the next GET events call to obtain subsequent events
smartsheet: SuccessResult
Fields
- resultCode? 0 -
- '0' Success
- message? "SUCCESS" - Message that indicates the request was successful
smartsheet: SummaryData
Fields
- result? SummaryFieldAddImage -
smartsheet: SummaryField
Fields
- hyperlink? Hyperlink - Represents a hyperlink, which can be a URL or a link to a report, sheet, or dashboard
- image? Image - Represents an image object, including its unique ID, dimensions, and alternate text
- symbol? string - When applicable for PICKLIST column type
- contactOptions? ContactOption[] - Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST
- modifiedAt? Timestamp -
- format? string - The format descriptor. Only returned if the include query string parameter contains format and this column has a non-default format applied to it
- index? decimal - Field index or position. This number is zero-based
- objectValue? ObjectValue - The base object for values found in the Cell.objectValue attribute. Its objectType attribute indicates the type of the object. This object itself is not used directly
- title? string - Arbitrary name, must be unique within summary
- 'type? "ABSTRACT_DATETIME"|"CHECKBOX"|"CONTACT_LIST"|"DATE"|"DATETIME"|"DURATION"|"MULTI_CONTACT_LIST"|"MULTI_PICKLIST"|"PICKLIST"|"PREDECESSOR"|"TEXT_NUMBER" -
- displayValue? string - Visual representation of cell contents, as presented to the user in the UI
- createdAt? Timestamp -
- createdBy? MiniUser - User object containing name and email of the creator of this summary field
- options? string[] - When applicable for PICKLIST column type. Array of the options available for the field
- formula? string - The formula for a cell, if set
- lockedForUser? boolean - Indicates whether the field is locked for the requesting user
- modifiedBy? MiniUser - User object containing name and email of the user who most recently modified this summary field
- id? decimal - SummaryField Id
- locked? boolean - Indicates whether the field is locked
- validation? boolean - Indicates whether summary field values are restricted to the type
smartsheet: SummaryFieldAddImage
Fields
- image? Image - Represents an image object, including its unique ID, dimensions, and alternate text
- createdAt? Timestamp -
- modifiedAt? Timestamp -
- index? decimal - Field index or position. This number is zero-based
- lockedForUser? boolean - Indicates whether the field is locked for the requesting user
- formula? string - The formula for a cell, if set
- objectValue? ObjectValue - The base object for values found in the Cell.objectValue attribute. Its objectType attribute indicates the type of the object. This object itself is not used directly
- id? decimal - SummaryField Id
- title? string - Arbitrary name, must be unique within summary
- 'type? "ABSTRACT_DATETIME"|"CHECKBOX"|"CONTACT_LIST"|"DATE"|"DATETIME"|"DURATION"|"MULTI_CONTACT_LIST"|"MULTI_PICKLIST"|"PICKLIST"|"PREDECESSOR"|"TEXT_NUMBER" -
- locked? boolean - Indicates whether the field is locked
- version? decimal - Sheet version number that is incremented every time a sheet is modified
smartsheet: SummaryFieldBulkCreateData
A list of created summary fields
Fields
- result? SummaryField[] - List of summary fields created by the operation
smartsheet: SummaryFieldBulkCreateResponse
Fields
- Fields Included from *SummaryFieldBulkCreateData
- result SummaryField[]
- anydata...
smartsheet: SummaryFieldCreateData
Fields
- result? SummaryField[] - A list of updated summary fields
smartsheet: SummaryFieldCreateRequest
SummaryField object to create
Fields
- hyperlink? Hyperlink - Represents a hyperlink, which can be a URL or a link to a report, sheet, or dashboard
- image? Image - Represents an image object, including its unique ID, dimensions, and alternate text
- symbol? PropertiesSymbol - When applicable for PICKLIST column type
- contactOptions? PropertiesContactOptions - Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST
- format? Format - The format descriptor. Only returned if the include query string parameter contains format and this column has a non-default format applied to it
- index? Index - Field index or position. This number is zero-based
- objectValue? ObjectValue - The base object for values found in the Cell.objectValue attribute. Its objectType attribute indicates the type of the object. This object itself is not used directly
- title? PropertiesTitle - Arbitrary name, must be unique within summary
- 'type? PropertiesType - Specifies the type of a column property. Valid values include various column data types such as CHECKBOX, CONTACT_LIST, DATE, PICKLIST, and others
- options? PropertiesOptions - When applicable for PICKLIST column type. Array of the options available for the field
- formula? Formula - The formula for a cell, if set
- locked? Locked - Indicates whether the field is locked
- validation? Validation - Indicates whether summary field values are restricted to the type
smartsheet: SummaryFieldCreateResponse
Fields
- Fields Included from *SummaryFieldCreateData
- result SummaryField[]
- anydata...
smartsheet: SummaryFieldDeleteData
A list of fieldIds corresponding to all summary fields that were successfully deleted
Fields
- result? decimal[] - List of field IDs for summary fields that were successfully deleted
smartsheet: SummaryFieldDeleteResponse
Fields
- Fields Included from *SummaryFieldDeleteData
- result decimal[]
- anydata...
smartsheet: SummaryFieldListResponse
Fields
- Fields Included from *IndexResult
- data? SummaryField[] - List of Summary Fields
smartsheet: SummaryFieldUpdateRequest
SummaryField object to update
Fields
- hyperlink? Hyperlink - Represents a hyperlink, which can be a URL or a link to a report, sheet, or dashboard
- image? Image - Represents an image object, including its unique ID, dimensions, and alternate text
- symbol? PropertiesSymbol - When applicable for PICKLIST column type
- contactOptions? PropertiesContactOptions - Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST
- format? Format - The format descriptor. Only returned if the include query string parameter contains format and this column has a non-default format applied to it
- index? Index - Field index or position. This number is zero-based
- objectValue? ObjectValue - The base object for values found in the Cell.objectValue attribute. Its objectType attribute indicates the type of the object. This object itself is not used directly
- title? PropertiesTitle - Arbitrary name, must be unique within summary
- 'type? PropertiesType - Specifies the type of a column property. Valid values include various column data types such as CHECKBOX, CONTACT_LIST, DATE, PICKLIST, and others
- options? PropertiesOptions - When applicable for PICKLIST column type. Array of the options available for the field
- formula? Formula - The formula for a cell, if set
- id? PropertiesId - SummaryField Id
- locked? Locked - Indicates whether the field is locked
- validation? Validation - Indicates whether summary field values are restricted to the type
smartsheet: SummaryResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *SummaryData
- result SummaryFieldAddImage
- anydata...
smartsheet: Template
A template can be used to create a sheet
Fields
- globalTemplate? "BLANK_SHEET"|"PROJECT_SHEET"|"TASK_LIST" - Type of global template. Only applicable to blank public templates
- image? string - URL to the small preview image for this template. Only applicable to non-blank public templates
- largeImage? string - URL to the large preview image for this template. Only applicable to non-blank public templates
- blank? boolean - Indicates whether the template is blank. Only applicable to public templates
- accessLevel? AccessLevel - Specifies the user's level of access or permissions, such as ADMIN, OWNER, EDITOR, or VIEWER
- name? string - Type of global template
- description? string - Template description
- id? decimal - Template Id
- categories? string[] - Indicates whether the template is blank. Only applicable to public templates
- 'type? "report"|"sheet" - Type of template. Only applicable to public templates
- locale? "ar_AE"|"ar_BH"|"ar_DZ"|"ar_EG"|"ar_IQ"|"ar_JO"|"ar_KW"|"ar_LB"|"ar_LY"|"ar_MA"|"ar_OM"|"ar_QA"|"ar_SA"|"ar_SD"|"ar_SY"|"ar_TN"|"ar_YE"|"be_BY"|"bg_BG"|"ca_ES"|"cs_CZ"|"da_DK"|"de_AT"|"de_CH"|"de_DE"|"de_LU"|"el_CY"|"el_GR"|"en_AU"|"en_CA"|"en_GB"|"en_IE"|"en_IN"|"en_MT"|"en_NZ"|"en_PH"|"en_SG"|"en_US"|"en_ZA"|"es_AR"|"es_BO"|"es_CL"|"es_CO"|"es_CR"|"es_DO"|"es_EC"|"es_ES"|"es_GT"|"es_HN"|"es_MX"|"es_NI"|"es_PA"|"es_PE"|"es_PR"|"es_PY"|"es_SV"|"es_US"|"es_UY"|"es_VE"|"et_EE"|"fi_FI"|"fr_BE"|"fr_CA"|"fr_CH"|"fr_FR"|"fr_LU"|"ga_IE"|"hi_US"|"hr_HR"|"hu_HU"|"in_ID"|"is_IS"|"it_CH"|"it_IT"|"iw_IL"|"ja_JP"|"ko_KR"|"lt_LT"|"lv_LV"|"mk_MK"|"ms_MY"|"mt_MT"|"nl_BE"|"nl_NL"|"no_NO"|"pl_PL"|"pt_BR"|"pt_PT"|"ro_RO"|"ru_RU"|"sk_SK"|"sl_SI"|"sq_AL"|"sr_BA"|"sr_CS"|"sv_SE"|"th_US"|"tr_TR"|"uk_UA"|"vi_VN"|"zh_CN"|"zh_HK"|"zh_SG"|"zh_TW" - Locale of the template. Only applicable to public templates
smartsheet: TemplateItemData
Fields
- accessLevel? AccessLevel - Specifies the user's level of access or permissions, such as ADMIN, OWNER, EDITOR, or VIEWER
- name? string - The report's name
- isSummaryReport? boolean - It is
trueif the report is a sheet summary; otherwise it is a row report
- id? decimal - The report's unique identifier
- permalink? string - URL to the report in Smartsheet
smartsheet: TemplateListData
Fields
- data? TemplateItemData[] - List of all accessible reports, referenced by their ID, name, access level, and summary report flag values
smartsheet: TemplateListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *TemplateListData
- data TemplateItemData[]
- anydata...
smartsheet: TemplatesListHeaders
Represents the Headers record for the operation: templates-list
Fields
smartsheet: TemplatesListPublicHeaders
Represents the Headers record for the operation: templates-listPublic
Fields
smartsheet: TemplatesListPublicQueries
Represents the Queries record for the operation: templates-listPublic
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- level 0|1 (default 0) - Level of public template types. 0 refers to only Sheet types, 1 refers to all types
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: TemplatesListQueries
Represents the Queries record for the operation: templates-list
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: Token
Fields
- accessToken? string - A credential that can be used by a client to access the Smartsheet API
- refreshToken? string - A credential tied to the access token that can be used to obtain a fresh access token with the same permissions, without further involvement from a user
- tokenType? string - How an access token will be generated and presented. Smartsheet uses the bearer parameter, which means essentially give access to the bearer of this token
- expiresIn decimal(default 604799) - Number of seconds token is valid once issued
smartsheet: TokenData
Fields
smartsheet: TokenResponse
Fields
- Fields Included from *TokenData
smartsheet: TokensDeleteHeaders
Represents the Headers record for the operation: tokens-delete
Fields
smartsheet: TokensDeleteQueries
Represents the Queries record for the operation: tokens-delete
Fields
- deleteAllForApiClient boolean(default false) - The client Id and user Id is fetched based on the token that is used to make this API call. A value of true deletes all tokens associated to the given client Id and user Id
smartsheet: TokensGetOrRefreshHeaders
Represents the Headers record for the operation: tokens-getOrRefresh
Fields
- contentType? "application/x-www-form-urlencoded" - Required for POST and PUT requests. Defines the structure for the response
smartsheet: TokensGetOrRefreshQueries
Represents the Queries record for the operation: tokens-getOrRefresh
Fields
- refreshToken? string - refresh_token value that came with the access token
- code? string - Authorization code acquired after user selects "Allow" in the Web login UI
- grantType "authorization_code"|"refresh_token" - Must be set to "authorization_code"
- clientSecret? string - (Optional) Must use either this value or hash. Plain text method for sending this value. For example, client_secret={app_secret}. Encryption occurs at the HTTPS level
- clientId string - The client Id you obtained when you registered your app
- hash? string - (Optional) Must use either this value or client_secret. SHA-256 hash of your app secret concatenated with a pipe and the authorization code. For example, hash={SHA_256(app_secret|code)}
- redirectUrl? string - Deprecated If supplied, must match the redirect URI you registered for your app
smartsheet: UpdateColumn
Fields
- options? string[] - Array of the options available for the column
- index? decimal - Column index or position. This number is zero-based
- id? decimal - Column Id
- title? string - Column title
- 'type? "ABSTRACT_DATETIME"|"CHECKBOX"|"CONTACT_LIST"|"DATE"|"DATETIME"|"DURATION"|"MULTI_CONTACT_LIST"|"MULTI_PICKLIST"|"PICKLIST"|"PREDECESSOR"|"TEXT_NUMBER" - See Column Types
- validation? boolean - Indicates whether validation has been enabled for the column (value = true)
smartsheet: UpdateFolderHeaders
Represents the Headers record for the operation: update-folder
Fields
smartsheet: UpdateGroupHeaders
Represents the Headers record for the operation: update-group
Fields
smartsheet: UpdateProofStatusRequest
Fields
- isCompleted? boolean -
smartsheet: UpdateReportShareHeaders
Represents the Headers record for the operation: update-report-share
Fields
smartsheet: UpdateReportShareQueries
Represents the Queries record for the operation: update-report-share
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
smartsheet: UpdateRequest
Fields
- Fields Included from *UpdateRequestAllOf2
smartsheet: UpdateRequestAllOf2
Fields
- createdAt? Timestamp - The date and time for when this request was originally created. Read-only
- schedule? Schedule - The schedule for which update requests are sent out
- modifiedAt? Timestamp - The date and time for when the last change was made to this request. Read-only
- id? decimal - Id of the update request
- sentBy? MiniUser -
Userobject containingnameandemailof the sender
smartsheet: UpdateRequestCreate
Fields
- Fields Included from *Event
- action? "CREATE" - The action applied to the specified object
- additionalDetails? UpdateRequestCreateAdditionalDetails -
- objectType? "UPDATE_REQUEST" - The Smartsheet resource impacted by the event
smartsheet: UpdateRequestCreateAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- includeAttachments? boolean - Indicates whether the row(s) were sent with their respective attachments
- sheetId? int - Id of the sheet that owns the rows sent in the update request
- rowCount? int - Number of rows sent in the update request
- includeDiscussions? boolean - Indicates whether the row(s) were sent with their respective discussion comments
smartsheet: UpdateRequestCreateData
Fields
- result? UpdateRequest -
smartsheet: UpdateRequestCreateResponse
Fields
- Fields Included from *UpdateRequestCreateData
- result UpdateRequest
- anydata...
smartsheet: UpdateRequestListData
Fields
- data? UpdateRequest[] - list of UpdateRequest objects
smartsheet: UpdateRequestListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *UpdateRequestListData
- data UpdateRequest[]
- anydata...
smartsheet: UpdaterequestsCreateHeaders
Represents the Headers record for the operation: updaterequests-create
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: UpdaterequestsDeleteHeaders
Represents the Headers record for the operation: updaterequests-delete
Fields
smartsheet: UpdaterequestsGetHeaders
Represents the Headers record for the operation: updaterequests-get
Fields
smartsheet: UpdaterequestsListHeaders
Represents the Headers record for the operation: updaterequests-list
Fields
smartsheet: UpdaterequestsListQueries
Represents the Queries record for the operation: updaterequests-list
Fields
- pageSize decimal(default 100) - The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request
- includeAll boolean(default false) - If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified)
- page decimal(default 1) - Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned
smartsheet: UpdaterequestsUpdateHeaders
Represents the Headers record for the operation: updaterequests-update
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: UpdateRowsHeaders
Represents the Headers record for the operation: update-rows
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: UpdateRowsObject
Fields
- createdAt? Timestamp -
- expanded? boolean - Indicates whether the row is expanded or collapsed
- cells? CellObjectForRows[] - Cells objects
- modifiedAt? Timestamp -
- id? decimal - Row Id
- rowNumber? decimal - Row number within the sheet
- parentRowNumber? decimal - The row number of the parent
- version? decimal - Sheet version number that is incremented every time a sheet is modified
- parentId? decimal - The Id of the parent
smartsheet: UpdateRowsQueries
Represents the Queries record for the operation: update-rows
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
- allowPartialSuccess boolean(default false) - When specified with a value of true, enables partial success for this bulk operation. See Bulk operations > Partial success for more information
- overrideValidation boolean(default false) - You may use the query string parameter overrideValidation with a value of true to allow a cell value outside of the validation limits. You must specify strict with a value of false to bypass value type checking
smartsheet: UpdateSheet
Fields
- userSettings? SheetUserSettings - Represents individual user settings for a specific sheet. User settings may be updated even on sheets where the current user only has read access (for example, viewer permissions or a read-only sheet)
- name? string - Sheet name
- projectSettings? ProjectSettings - Represents the project settings dependencies for a specific sheet. Project settings may be updated on sheets that the user has editor access
smartsheet: UpdateSheetHeaders
Represents the Headers record for the operation: updateSheet
Fields
smartsheet: UpdateSheetQueries
Represents the Queries record for the operation: updateSheet
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
smartsheet: UpdateSheetShareHeaders
Represents the Headers record for the operation: update-sheet-share
Fields
smartsheet: UpdateSheetShareQueries
Represents the Queries record for the operation: update-sheet-share
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
smartsheet: UpdateSightHeaders
Represents the Headers record for the operation: update-sight
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: UpdateSightQueries
Represents the Queries record for the operation: update-sight
Fields
- numericDates boolean(default false) - You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request
smartsheet: UpdateSightShareHeaders
Represents the Headers record for the operation: update-sight-share
Fields
smartsheet: UpdateSightShareQueries
Represents the Queries record for the operation: update-sight-share
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
smartsheet: UpdateSummaryFieldsHeaders
Represents the Headers record for the operation: update-summary-fields
Fields
smartsheet: UpdateSummaryFieldsQueries
Represents the Queries record for the operation: update-summary-fields
Fields
- renameIfConflict boolean(default false) - Set to true if you want to override the requirement for unique summary field names. Repeated names will be adjusted by appending "(1)" or similar after the field name
smartsheet: UpdateUserHeaders
Represents the Headers record for the operation: update-user
Fields
smartsheet: UpdateUserProfileImageHeaders
Represents the Headers record for the operation: update-user-profile-image
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: UpdateWebhookHeaders
Represents the Headers record for the operation: updateWebhook
Fields
- contentType string(default "application/json") - Required for POST and PUT requests. Defines the structure for the request body
smartsheet: UpdateWebhookRequest
Fields
- Fields Included from *CreateWebhookRequest
- Fields Included from *UpdateWebhookRequestAllOf2
- enabled boolean
- anydata...
smartsheet: UpdateWebhookRequestAllOf2
Fields
- enabled? boolean - Indicates whether the webhook is on (true) or off (false)
smartsheet: UpdateWorkspaceHeaders
Represents the Headers record for the operation: update-workspace
Fields
smartsheet: UpdateWorkspaceQueries
Represents the Queries record for the operation: update-workspace
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
smartsheet: UpdateWorkspaceShareHeaders
Represents the Headers record for the operation: update-workspace-share
Fields
smartsheet: UpdateWorkspaceShareQueries
Represents the Queries record for the operation: update-workspace-share
Fields
- accessApiLevel decimal(default 0) - Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1
smartsheet: User
User Object
Fields
- lastLogin? string - Last login time of the current user
- lastName? string - User's last name
- customWelcomeScreenViewed? string - Timestamp of viewing an <a href="https://help.smartsheet.com/articles/1392225-customizing-a-welcome-message-upgrade-screen-enterprise-only" target="_blank" rel="noopener noreferrer">Enterprise Custom Welcome Screen</a> by the current user
- admin boolean(default false) - Indicates whether the user is a system admin (can manage user accounts and organization account)
- profileImage? ProfileImage - Represents a user's profile image including its unique ID, width, and height
- firstName? string - User's first name
- groupAdmin boolean(default false) - Indicates whether the user is a group admin (can create and edit groups)
- name? string - User's full name (read-only)
- resourceViewer boolean(default false) - Indicates whether the user is a resource viewer (can access resource views)
- id? decimal - User Id
- sheetCount decimal(default -1) - SUNSET - The
sheetCountattribute now holds the value-1and is included only if the retrieved user'sstatusisACTIVE
- email? string - User's primary email address
- licensedSheetCreator boolean(default false) - Indicates whether the user is a licensed user (can create and own sheets)
- status? "ACTIVE"|"DECLINED"|"PENDING"|"DEACTIVATED" - User status, set to one of the listed enum values
smartsheet: UserAcceptInvite
Fields
- Fields Included from *Event
- action? "ACCEPT_INVITE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "USER" - The Smartsheet resource impacted by the event
smartsheet: UserAddToAccount
Fields
- Fields Included from *Event
- action? "ADD_TO_ACCOUNT" - The action applied to the specified object
- additionalDetails? UserAddToAccountAdditionalDetails -
- objectType? "USER" - The Smartsheet resource impacted by the event
smartsheet: UserAddToAccountAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- userTypes? string - Comma-delimited list of user types, e.g.
SYSTEM_ADMIN,LICENSED_USER,GROUP_ADMIN,RESOURCE_VIEWER,JIRA_ADMIN,JIRA_USER,SALESFORCE_ADMIN,SALESFORCE_USER. The full list of available user types can be seen <a href="https://help.smartsheet.com/learning-track/shared-users/user-types-and-permissions" target="_blank" rel="noopener noreferrer">here</a>. Please notice that user types Unlicensed User and Free Collaborator are not applicable for this event
smartsheet: UserCreateData
smartsheet: UserCreateResponse
Fields
- Fields Included from *SearchResult
- results SearchResultItem[]
- totalCount decimal
- anydata...
- Fields Included from *UserCreateData
- anydata...
smartsheet: UserData
Fields
- result? Share[] -
smartsheet: UserDeclineInvite
Fields
- Fields Included from *Event
- action? "DECLINE_INVITE" - The action applied to the specified object
- additionalDetails? UserDeclineInviteAdditionalDetails -
- objectType? "USER" - The Smartsheet resource impacted by the event
smartsheet: UserDeclineInviteAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- declineReason? "ACCEPT_FAILED_REMOVED_FROM_ORG"|"ACCEPT_FAILED_IN_OTHER_ORG"|"ACCEPT_FAILED_IS_PAID_USER"|"ACCEPT_FAILED_NEEDS_LICENSE"|"ACCEPT_FAILED_INSUFFICIENT_LICENSES"|"ACCEPT_FAILED_NOT_ELIGIBLE_FOR_TRIAL"|"ACCEPT_FAILED"|"ACCEPT_FAILED_NEEDS_GROUP_ADMIN_ROLE"|"ACCEPT_FAILED_UAP_VIOLATION"|"DECLINE_SUCCESS" -
smartsheet: UserDownloadSheetAccessReport
Fields
- Fields Included from *Event
- action? "DOWNLOAD_SHEET_ACCESS_REPORT" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "USER" - The Smartsheet resource impacted by the event
smartsheet: UserImgProfileResponse
Fields
- Fields Included from *UserProfile
- jiraAdmin boolean
- lastLogin string
- lastName string
- role string
- admin boolean
- profileImage ProfileImage
- locale string
- title string
- salesforceUser boolean
- groupAdmin boolean
- resourceViewer boolean
- company string
- id decimal
- department string
- email string
- customWelcomeScreenViewed string
- timeZone string
- firstName string
- mobilePhone string
- alternateEmails AlternateEmail
- workPhone string
- sheetCount decimal
- account Account
- licensedSheetCreator boolean
- salesforceAdmin boolean
- anydata...
- Fields Included from *UserProfileImageData
- data Group[]
- anydata...
smartsheet: UserListData
Fields
- data? User[] - List of User Objects
smartsheet: UserListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *UserListData
- data User[]
- anydata...
smartsheet: UserProfile
Fields
- jiraAdmin? boolean - Indicates whether the user is a JIRA admin
- lastLogin? string - Last login time of the current user
- lastName? string - Current user's last name
- role? string - User's role
- admin? boolean - Indicates whether the user is a system admin (can manage user accounts and organization account)
- profileImage? ProfileImage - Represents a user's profile image including its unique ID, width, and height
- locale? string - Current user's locale (see ServerInfo)
- title? string - User's title
- salesforceUser? boolean - Indicates whether the user is a registered Salesforce user
- groupAdmin? boolean - Indicates whether the user is a group admin (can create and edit groups)
- resourceViewer? boolean - Indicates whether the user is a resource viewer (can access resource views)
- company? string - User's company
- id? decimal - Current user's Id
- department? string - User's department
- email? string - Current user's primary email address
- customWelcomeScreenViewed? string - Timestamp of viewing an <a href="https://help.smartsheet.com/articles/1392225-customizing-a-welcome-message-upgrade-screen-enterprise-only" target="_blank" rel="noopener noreferrer">Enterprise Custom Welcome Screen</a> by the current user
- timeZone? string - Current user's time zone Id
- firstName? string - Current user's first name
- mobilePhone? string - User's mobile phone number
- alternateEmails? AlternateEmail -
- workPhone? string - User's work phone number
- sheetCount decimal(default -1) - SUNSET - The
sheetCountattribute now holds the value-1and is included only if the retrieved user'sstatusisACTIVE
- account? Account -
- licensedSheetCreator? boolean - Indicates whether the user is a licensed user (can create and own sheets)
- salesforceAdmin? boolean - Indicates whether the user is a Salesforce admin
smartsheet: UserProfileData
Fields
- result? User - User Object
smartsheet: UserProfileImageData
Fields
- data? Group[] - List of Groups
smartsheet: UserProfileImageResponse
User profile image response
Fields
- email? string - User's primary email address.
- name? string - User's full name (read-only).
- firstName? string - User's first name.
- lastName? string - User's last name.
- profileImage? ProfileImage - Represents a user's profile image including its unique ID, width, and height
- id? decimal - User Id.
smartsheet: UserProfileResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *UserProfileData
- result User
- anydata...
smartsheet: UserRemoveFromAccount
Fields
- Fields Included from *Event
- action? "REMOVE_FROM_ACCOUNT" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "USER" - The Smartsheet resource impacted by the event
smartsheet: UserRemoveFromGroups
Fields
- Fields Included from *Event
- action? "REMOVE_FROM_GROUPS" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "USER" - The Smartsheet resource impacted by the event
smartsheet: UserRemoveShares
Fields
- Fields Included from *Event
- action? "REMOVE_SHARES" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "USER" - The Smartsheet resource impacted by the event
smartsheet: UserResponse
Fields
- Fields Included from *UserData
- result Share[]
- anydata...
smartsheet: UserSendInvite
Fields
- Fields Included from *Event
- action? "SEND_INVITE" - The action applied to the specified object
- additionalDetails? UserAddToAccountAdditionalDetails -
- objectType? "USER" - The Smartsheet resource impacted by the event
smartsheet: UserSendPasswordReset
Fields
- Fields Included from *Event
- action? "SEND_PASSWORD_RESET" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "USER" - The Smartsheet resource impacted by the event
smartsheet: UserTransferOwnedGroups
Fields
- Fields Included from *Event
- action? "TRANSFER_OWNED_GROUPS" - The action applied to the specified object
- additionalDetails? GroupTransferOwnershipAdditionalDetails -
- objectType? "USER" - The Smartsheet resource impacted by the event
smartsheet: UserTransferOwnedItems
Fields
- Fields Included from *Event
- action? "TRANSFER_OWNED_ITEMS" - The action applied to the specified object
- additionalDetails? GroupTransferOwnershipAdditionalDetails -
- objectType? "USER" - The Smartsheet resource impacted by the event
smartsheet: UserUpdate
Updates User for the following attributes:
- admin (required).
- licensedSheetCreator (required).
- firstName (optional).
- groupAdmin (optional).
- lastName (optional).
- resourceViewer (optional)
Fields
- firstName? string - User's first name
- lastName? string - User's last name
- groupAdmin boolean(default false) - Indicates whether the user is a group admin (can create and edit groups)
- resourceViewer boolean(default false) - Indicates whether the user is a resource viewer (can access resource views)
- admin boolean(default false) - Indicates whether the user is a system admin (can manage user accounts and organization account)
- licensedSheetCreator boolean(default false) - Indicates whether the user is a licensed user (can create and own sheets)
smartsheet: UserUpdateUser
Fields
- Fields Included from *Event
- action? "UPDATE_USER" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "USER" - The Smartsheet resource impacted by the event
smartsheet: Webhook
Fields
- Fields Included from *UpdateWebhookRequest
- Fields Included from *WebhookAllOf2
- apiClientName string
- createdAt Timestamp
- disabledDetails string
- stats WebhookStats
- modifiedAt Timestamp
- apiClientId string
- id decimal
- sharedSecret string
- status "DISABLED_ADMINISTRATIVE"|"DISABLED_APP_REVOKED"|"DISABLED_BY_OWNER"|"DISABLED_CALLBACK_FAILED"|"DISABLED_SCOPE_INACCESSIBLE"|"DISABLED_VERIFICATION_FAILED"|"ENABLED"|"NEW_NOT_VERIFIED"
- anydata...
smartsheet: WebhookAllOf2
Fields
- apiClientName? string - API client name corresponding to third-party app that created the webhook. Read-only. Only present if webhook was created by third-party app
- createdAt? Timestamp -
- disabledDetails? string - Details about the reason the webhook was disabled. Read-only. Only present when enabled=false
- stats? WebhookStats -
- modifiedAt? Timestamp -
- apiClientId? string - API client Id corresponding to third-party app that created the webhook. Read-only. Only present if webhook was created by third-party app
- id? decimal - Webhook Id
- status? "DISABLED_ADMINISTRATIVE"|"DISABLED_APP_REVOKED"|"DISABLED_BY_OWNER"|"DISABLED_CALLBACK_FAILED"|"DISABLED_SCOPE_INACCESSIBLE"|"DISABLED_VERIFICATION_FAILED"|"ENABLED"|"NEW_NOT_VERIFIED" - Webhook status. Read-only. See Webhook Status for list of possible values
smartsheet: WebhookData
Fields
- result? SheetCreated|SheetCreatedFromTemplate -
smartsheet: WebhookListData
Fields
- result? SheetImported - Sheet imported from CSV / XLSX file
smartsheet: WebhookListResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *WebhookListData
- result SheetImported
- anydata...
smartsheet: WebhookResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *WebhookData
- result SheetCreated|SheetCreatedFromTemplate
- anydata...
smartsheet: WebhooksAllOf2
smartsheet: WebhooksBody
Fields
- Fields Included from *CreateWebhookRequest
- Fields Included from *WebhooksAllOf2
- anydata...
smartsheet: WebhookStats
Fields
- lastCallbackAttemptRetryCount? decimal - The number of retries the webhook had performed as of the last callback attempt
- lastSuccessfulCallback? string - When this webhook last made a successful callback
- lastCallbackAttempt? string - When this webhook last made a callback attempt
smartsheet: Workspace
Can contain dashboards, folders, reports, sheets, and templates
Fields
- reports? GridListing[] - Reports contained in the workspace
- sheets? GridListing[] - Sheets contained in the workspace
- folders? Folder[] - Folders contained in the workspace
- sights? DashboardListing[] - Dashboards contained in the workspace
- accessLevel? AccessLevel - Specifies the user's level of access or permissions, such as ADMIN, OWNER, EDITOR, or VIEWER
- name? string - Workspace name
- id? decimal - Workspace Id
- permalink? string - URL that represents a direct link to the workspace in Smartsheet
smartsheet: WorkspaceAddShare
Fields
- Fields Included from *Event
- action? "ADD_SHARE" - The action applied to the specified object
- additionalDetails? WorkspaceAddShareAdditionalDetails -
- objectType? "WORKSPACE" - The Smartsheet resource impacted by the event
smartsheet: WorkspaceAddShareAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- accessLevel? "VIEWER"|"EDITOR"|"EDITOR_SHARE"|"ADMIN" - Indicates the access level granted to the group or user. Note that this access level represents the access level granted by this specific sharing action; it is not the group or user's effective access level for the workspace
- groupId? int - Id of the group that was added to the workspace's sharing list. (Specific to share to group actions)
- userId? int - Id of the user that was added to the workspace's sharing list. (Specific to share to user actions)
smartsheet: WorkspaceAddShareMember
Fields
- Fields Included from *Event
- action? "ADD_SHARE_MEMBER" - The action applied to the specified object
- additionalDetails? WorkspaceAddShareMemberAdditionalDetails -
- objectType? "WORKSPACE" - The Smartsheet resource impacted by the event
smartsheet: WorkspaceAddShareMemberAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- accessLevel? "VIEWER"|"EDITOR"|"EDITOR_SHARE"|"ADMIN" - Indicates the access level granted to the user. Note that this access level represents the access level that has been granted to the user via group membership; it is not the user's effective access level for the workspace
- groupId? int - Id of the group the user was added to
- userId? int - Id of the user that was added to the group
smartsheet: WorkspaceCreate
Fields
- Fields Included from *Event
- action? "CREATE" - The action applied to the specified object
- additionalDetails? WorkspaceCreateAdditionalDetails -
- objectType? "WORKSPACE" - The Smartsheet resource impacted by the event
smartsheet: WorkspaceCreateAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- sourceWorkspaceId? int - Id of workspace that was copied to create the new workspace. (Only included if the workspace was created as a result of a save as new or copy)
- workspaceName? string - Name of the workspace
smartsheet: WorkspaceCreateData
Fields
- result? Workspace - Can contain dashboards, folders, reports, sheets, and templates
smartsheet: WorkspaceCreateRecurringBackup
Fields
- Fields Included from *Event
- action? "CREATE_RECURRING_BACKUP" - The action applied to the specified object
- additionalDetails? WorkspaceCreateRecurringBackupAdditionalDetails -
- objectType? "WORKSPACE" - The Smartsheet resource impacted by the event
smartsheet: WorkspaceCreateRecurringBackupAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- includeAttachments? boolean - Indicates whether attachments should be included in the recurring backup
- sendCompletionEmail? boolean - Indicates whether an email should be sent to the workspace's owner every time a recurring backup completes
smartsheet: WorkspaceCreateResponse
Fields
- Fields Included from *WorkspaceCreateData
- result Workspace
- anydata...
smartsheet: WorkspaceData
Fields
- result? WorkspaceListing -
smartsheet: WorkspaceDelete
Fields
- Fields Included from *Event
- action? "DELETE" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "WORKSPACE" - The Smartsheet resource impacted by the event
smartsheet: WorkspaceDeleteRecurringBackup
Fields
- Fields Included from *Event
- action? "DELETE_RECURRING_BACKUP" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "WORKSPACE" - The Smartsheet resource impacted by the event
smartsheet: WorkspaceExport
Fields
- Fields Included from *Event
- action? "EXPORT" - The action applied to the specified object
- additionalDetails? WorkspaceExportAdditionalDetails -
- objectType? "WORKSPACE" - The Smartsheet resource impacted by the event
smartsheet: WorkspaceExportAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- formatType? "excel"|"pdf" - The format that the workspace was exported ("excel" or "pdf"). Notice that the same value "excel" is displayed either when exporting to Microsoft Excel or when exporting to Google Sheets
smartsheet: WorkspaceFolderCreateData
Fields
- result? Webhook -
smartsheet: WorkspaceFolderCreateResponse
Fields
- Fields Included from *WorkspaceFolderCreateData
- result Webhook
- anydata...
smartsheet: WorkspaceFolderListData
Fields
- data? Webhook[] - list of Webhooks
smartsheet: WorkspaceFolderListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *WorkspaceFolderListData
- data Webhook[]
- anydata...
smartsheet: WorkspaceListData
Fields
- data? Template[] - list of Templates
smartsheet: WorkspaceListing
Fields
- accessLevel? AccessLevel - Specifies the user's level of access or permissions, such as ADMIN, OWNER, EDITOR, or VIEWER
- name? string - Workspace name
- id? decimal - Workspace Id
- permalink? string - URL that represents a direct link to the workspace in Smartsheet
smartsheet: WorkspaceListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *WorkspaceListData
- data Template[]
- anydata...
smartsheet: WorkspaceRemoveShare
Fields
- Fields Included from *Event
- action? "REMOVE_SHARE" - The action applied to the specified object
- additionalDetails? WorkspaceRemoveShareAdditionalDetails -
- objectType? "WORKSPACE" - The Smartsheet resource impacted by the event
smartsheet: WorkspaceRemoveShareAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- groupId? int - Id of the group that was removed from the workspace's sharing list. (Specific to remove share from group actions)
- userId? int - Id of the user that was removed from the workspace's sharing list. (Specific to remove share from user actions)
smartsheet: WorkspaceRemoveShareMember
Fields
- Fields Included from *Event
- action? "REMOVE_SHARE_MEMBER" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "WORKSPACE" - The Smartsheet resource impacted by the event
smartsheet: WorkspaceRename
Fields
- Fields Included from *Event
- action? "RENAME" - The action applied to the specified object
- additionalDetails? WorkspaceRenameAdditionalDetails -
- objectType? "WORKSPACE" - The Smartsheet resource impacted by the event
smartsheet: WorkspaceRenameAdditionalDetails
Fields
- emailAddress string - Email address of the user responsible for the event
- newName? string - New name of the workspace
- oldName? string - Previous name of the workspace
smartsheet: WorkspaceRequestBackup
Fields
- Fields Included from *Event
- action? "REQUEST_BACKUP" - The action applied to the specified object
- additionalDetails? FolderRequestBackupAdditionalDetails -
- objectType? "WORKSPACE" - The Smartsheet resource impacted by the event
smartsheet: WorkspaceResponse
Fields
- Fields Included from *GenericResult
- resultCode 0|3
- message "PARTIAL_SUCCESS"|"SUCCESS"
- anydata...
- Fields Included from *WorkspaceData
- result WorkspaceListing
- anydata...
smartsheet: WorkspaceSaveAsNew
Fields
- Fields Included from *Event
- action? "SAVE_AS_NEW" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "WORKSPACE" - The Smartsheet resource impacted by the event
smartsheet: WorkspacesBody
Fields
- name? string - Workspace name
smartsheet: WorkspaceShareCreateData
Fields
- result? SharedSecret -
smartsheet: WorkspaceShareCreateResponse
Fields
- Fields Included from *WorkspaceShareCreateData
- result SharedSecret
- anydata...
smartsheet: WorkspaceShareListData
Fields
- data? WorkspaceListing[] -
smartsheet: WorkspaceShareListResponse
Fields
- Fields Included from *IndexResult
- Fields Included from *WorkspaceShareListData
- data WorkspaceListing[]
- anydata...
smartsheet: WorkspacesworkspaceIdBody
Fields
- name? string - Workspace name
smartsheet: WorkspaceTransferOwnership
Fields
- Fields Included from *Event
- action? "TRANSFER_OWNERSHIP" - The action applied to the specified object
- additionalDetails? AccountBulkUpdateAdditionalDetails -
- objectType? "WORKSPACE" - The Smartsheet resource impacted by the event
smartsheet: WorkspaceUpdateRecurringBackup
Fields
- Fields Included from *Event
- action? "UPDATE_RECURRING_BACKUP" - The action applied to the specified object
- additionalDetails? FolderRequestBackupAdditionalDetails -
- objectType? "WORKSPACE" - The Smartsheet resource impacted by the event
Union types
smartsheet: FavoritesBody
FavoritesBody
smartsheet: ReadOnlyFullDefaultView
ReadOnlyFullDefaultView
Indicates which view the user has set for a read-only, default view of the published sheet. Must be one of the listed enum values
smartsheet: SheetsBody
SheetsBody
smartsheet: SheetIdSharesBody
SheetIdSharesBody
smartsheet: AccessLevel
AccessLevel
Specifies the user's level of access or permissions, such as ADMIN, OWNER, EDITOR, or VIEWER
smartsheet: TimestampWriteable
TimestampWriteable
smartsheet: EventUnionData
EventUnionData
smartsheet: ReadWriteDefaultView
ReadWriteDefaultView
Indicates which view the user has set for a read-write, default view of the published sheet. Must be one of the listed enum values
smartsheet: SheetIdRowsBody1
SheetIdRowsBody1
smartsheet: Recipient
Recipient
Specifies the recipient of an email. The recipient may be either an individual or a group. To specify an individual, set the email attribute; to specify a group, set the groupId attribute. Either email and groupId may be set, but not both
smartsheet: Timestamp
Timestamp
smartsheet: ReportIdSharesBody
ReportIdSharesBody
smartsheet: Type
Type
See Column Types
smartsheet: ObjectValue
ObjectValue
The base object for values found in the Cell.objectValue attribute. Its objectType attribute indicates the type of the object. This object itself is not used directly
smartsheet: SystemColumnType
SystemColumnType
See System Columns
smartsheet: ReadWriteAccessibleBy
ReadWriteAccessibleBy
Indicates who can access the 'Edit by Anyone' view of the published sheet:
- ALL - available to anyone who has the link.
- ORG - available only to members of the sheet owner's Smartsheet organization account.
- SHARED - available only to users shared to the item.
Only returned in the response if readWriteEnabled = true
smartsheet: WorkspaceIdSharesBody
WorkspaceIdSharesBody
smartsheet: FolderIdSheetsBody
FolderIdSheetsBody
smartsheet: WorkspaceIdSheetsBody
WorkspaceIdSheetsBody
smartsheet: ReadOnlyFullAccessibleBy
ReadOnlyFullAccessibleBy
Indicates who can access the 'Read-Only Full' view of the published sheet:
- ALL - available to anyone who has the link.
- ORG - available only to members of the sheet owner's Smartsheet organization account.
- SHARED - available only to users shared to the item.
Only returned in the response if readOnlyFullEnabled = true
smartsheet: FavoriteResponse
FavoriteResponse
smartsheet: SheetIdRowsBody
SheetIdRowsBody
smartsheet: GroupIdMembersBody
GroupIdMembersBody
smartsheet: UserIdAlternateemailsBody
UserIdAlternateemailsBody
smartsheet: PropertiesType
PropertiesType
Specifies the type of a column property. Valid values include various column data types such as CHECKBOX, CONTACT_LIST, DATE, PICKLIST, and others
smartsheet: SheetIdCrosssheetreferencesBody
SheetIdCrosssheetreferencesBody
Array types
smartsheet: ReportsreportIdsharesOneOf2
ReportsreportIdsharesOneOf2
smartsheet: PropertiesOptions
PropertiesOptions
When applicable for PICKLIST column type. Array of the options available for the field
smartsheet: WorkspacesworkspaceIdsharesOneOf2
WorkspacesworkspaceIdsharesOneOf2
smartsheet: SheetssheetIdsharesOneOf2
SheetssheetIdsharesOneOf2
smartsheet: SheetssheetIdrowsOneOf21
SheetssheetIdrowsOneOf21
smartsheet: PropertiesContactOptions
PropertiesContactOptions
Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST
smartsheet: GroupMembersAddArray
GroupMembersAddArray
An array of GroupMemberAdd objects, each specifying the email address of a user to be added to a group
smartsheet: UsersuserIdalternateemailsOneOf2
UsersuserIdalternateemailsOneOf2
smartsheet: Columns
Columns
An array of Column objects, each defining the properties and configuration of a column in a sheet. See the Column schema for details on individual column attributes
smartsheet: ContactOptions
ContactOptions
Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST
smartsheet: SheetssheetIdrowsOneOf2
SheetssheetIdrowsOneOf2
smartsheet: FavoritesOneOf2
FavoritesOneOf2
smartsheet: Options
Options
Array of the options available for the column
smartsheet: GroupsgroupIdmembersOneOf2
GroupsgroupIdmembersOneOf2
String types
smartsheet: Format
Format
The format descriptor. Only returned if the include query string parameter contains format and this column has a non-default format applied to it
smartsheet: TimestampDateTime
TimestampDateTime
smartsheet: Formula
Formula
The formula for a cell, if set
smartsheet: PropertiesSymbol
PropertiesSymbol
When applicable for PICKLIST column type
smartsheet: Permalink
Permalink
URL that represents a direct link to the sheet in Smartsheet
smartsheet: Symbol
Symbol
When applicable for CHECKBOX or PICKLIST column types. See Symbol Columns
smartsheet: Name
Name
Sheet name
smartsheet: Title
Title
Column title
smartsheet: PropertiesTitle
PropertiesTitle
Arbitrary name, must be unique within summary
Decimal types
smartsheet: Id
Id
Sheet Id
smartsheet: Width
Width
Display width of the column in pixels
smartsheet: TimestampNumber
TimestampNumber
smartsheet: Index
Index
Field index or position. This number is zero-based
smartsheet: Version
Version
A number that is incremented every time a sheet is modified
smartsheet: PropertiesId
PropertiesId
SummaryField Id
Simple name reference types
smartsheet: WorkspaceIdCopyBody
WorkspaceIdCopyBody
smartsheet: HomeFoldersBody
HomeFoldersBody
smartsheet: RowResponse
RowResponse
smartsheet: Report
Report
smartsheet: ProofCreateResponse
ProofCreateResponse
smartsheet: CommentUpdateResponse
CommentUpdateResponse
smartsheet: SheetEmail
SheetEmail
smartsheet: AutomationRuleResponse
AutomationRuleResponse
smartsheet: ColumnResponse
ColumnResponse
smartsheet: FolderIdFoldersBody
FolderIdFoldersBody
smartsheet: MultiRowEmail
MultiRowEmail
smartsheet: FolderIdMoveBody
FolderIdMoveBody
smartsheet: ItemResult
ItemResult
smartsheet: ProofRequestBody
ProofRequestBody
smartsheet: RowEmail
RowEmail
smartsheet: CellHistory
CellHistory
smartsheet: AttachmentResponse
AttachmentResponse
smartsheet: CommentResponse
CommentResponse
smartsheet: ProofRequest
ProofRequest
smartsheet: DiscussionResponse
DiscussionResponse
smartsheet: SightListItem
SightListItem
smartsheet: SheetResponse
SheetResponse
smartsheet: FolderIdCopyBody
FolderIdCopyBody
smartsheet: WorkspaceShareDeleteResponse
WorkspaceShareDeleteResponse
smartsheet: Result
Result
smartsheet: ImageUrlMapResponse
ImageUrlMapResponse
smartsheet: Sight
Sight
smartsheet: ProofResponse
ProofResponse
smartsheet: InlineBodyItemsApplicationjsonimageurls
InlineBodyItemsApplicationjsonimageurls
smartsheet: SightResult
SightResult
Boolean types
smartsheet: ReadOnlyFullShowToolbar
DeprecatedReadOnlyFullShowToolbar
Deprecated Indicates whether the left nav toolbar is displayed. The default, or true, is to display the toolbar. If false, hides the toolbar
Deprecated
smartsheet: Validation
Validation
Indicates whether summary field values are restricted to the type
smartsheet: ReadWriteShowToolbar
DeprecatedReadWriteShowToolbar
Deprecated Indicates whether the left nav toolbar is displayed. The default, or true, is to display the toolbar. If false, hides the toolbar
Deprecated
smartsheet: Locked
Locked
Indicates whether the field is locked
smartsheet: ReadOnlyFullEnabled
ReadOnlyFullEnabled
If true, a rich version of the sheet is published with the ability to download row attachments and discussions
smartsheet: IcalEnabled
IcalEnabled
If true, a webcal is available for the calendar in the sheet
smartsheet: ReadWriteEnabled
ReadWriteEnabled
If true,a rich version of the sheet is published with the ability to edit cells and manage attachments and discussions
smartsheet: Primary
Primary
Returned only if the column is the Primary Column (value = true)
smartsheet: ReadOnlyLiteEnabled
ReadOnlyLiteEnabled
If true, a lightweight version of the sheet is published without row attachments and discussions
Import
import ballerinax/smartsheet;Other versions
1.0.0