Smartsheet (version v1.*.*)

userId (required)

Type: string

$body

Array of AlternateEmail objects, each limited to only the email attribute

Type: object

{
  "id" : "AlternateEmail Id",
  "confirmed" : "Indicates whether the alternate email address has been confirmed",
  "email" : "User's alternate email address"
}

sheetId (required)

Type: string

$body

Column object or an array of Column objects, with the following attributes: title type index (zero-based) autoNumberFormat (optional) description (optional) locked (optional) options (optional) symbol (optional) systemColumnType (optional) validation (optional) width (optional)

Type: object

{
  "symbol" : "When applicable for CHECKBOX or PICKLIST column types.",
  "contactOptions" : [ {
    "name" : "Can be a user's name, display name, or free text, such as a job class or TBD.",
    "email" : "A parsable email address."
  } ],
  "hidden" : "Indicates whether the column is hidden",
  "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.",
  "description" : "Column description.",
  "index" : "Column index or position. This number is zero-based.",
  "type" : "string. Possible values: ABSTRACT_DATETIME | CHECKBOX | CONTACT_LIST | DATE | DATETIME | DURATION | MULTI_CONTACT_LIST | PICKLIST | PREDECESSOR | TEXT_NUMBER",
  "title" : "Column title",
  "version" : "A zero-based integer indicating whether the column allows multi-contact data. A value of 0 indicates the data will be stored as text and the column type will be TEXT_NUMBER, a value of 1 for sheets and reports or a value of 2 for Sights (aka dashboards) indicates the data will be stored as contacts and the column type will be MULTI_CONTACT_LIST. If not specified, the default value is 0 for sheets and reports or 1 for Sights (aka dashboards).",
  "tags" : [ "string. Possible values: CALENDAR_END_DATE | CALENDAR_START_DATE | GANTT_ALLOCATION | GANTT_ASSIGNED_RESOURCE | GANTT_DISPLAY_LABEL | GANTT_DURATION | GANTT_END_DATE | GANTT_PERCENT_COMPLETE | GANTT_PREDECESSOR | GANTT_START_DATE" ],
  "autoNumberFormat" : {
    "prefix" : "The prefix. Can include the date tokens:{YY}{YYYY}{MM}{DD}",
    "startingNumber" : "The starting number for the auto-id",
    "fill" : "Indicates zero-padding. Must be between 0 and 10 \"0\" (zero) characters.",
    "suffix" : "The suffix. Can include the date tokens:{YY}{YYYY}{MM}{DD}"
  },
  "options" : [ "string" ],
  "width" : "Display width of the column in pixels",
  "lockedForUser" : "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" : "string. Possible values: AUTO_NUMBER | CREATED_BY | CREATED_DATE | MODIFIED_BY | MODIFIED_DATE",
  "id" : "Column Id",
  "locked" : "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" : "Indicates whether validation has been enabled for the column (value = true)",
  "primary" : "Returned only if the column is the Primary Column (value = true)"
}

discussionId (required)

Type: string

sheetId (required)

Type: string

$body

Comment object with the following attribute: text,Request body should contain parts with the following names: comment: JSON Comment object with the following attribute:text file: (optional) file to attach to the new commentSee Multipart Uploads for more information on parts.

Type: object

{
  "createdAt" : "Time of creation",
  "attachments" : [ {
    "createdAt" : "A timestamp of when the attachment was originally added",
    "attachmentSubType" : "Attachment sub type",
    "attachmentType" : "string. Possible values: BOX_COM | DROPBOX | EGNYTE | EVERNOTE | FILE | GOOGLE_DRIVE | LINK | ONEDRIVE",
    "createdBy" : { },
    "urlExpiresInMillis" : "Attachment temporary URL time to live (files only)",
    "name" : "Attachment name",
    "id" : "Attachment Id",
    "mimeType" : "Attachment MIME type (PNG, etc.)",
    "sizeInKb" : "The size of the file, if the attachmentType is FILE",
    "parentId" : "The Id of the parent",
    "parentType" : "The type of object the attachment belongs to",
    "url" : "Attachment temporary URL (files only)"
  } ],
  "createdBy" : { },
  "discussionId" : "Discussion Id",
  "modifiedAt" : "Time of last modification",
  "id" : "Comment Id",
  "text" : "Comment body"
}

$body

Favorite object or an array of Favorite objects, with the following attributes: objectId type

Type: object

{
  "type" : "string. Possible values: folder | report | sheet | sight | template | workspace",
  "objectId" : "Id of the favorited item. If type is template, only private sheet-type template Id is allowed."
}

allowPartialSuccess

If true, allows bulk operations to process even if one or more operations are invalid for some reason.

Type: boolean

groupId (required)

Type: string

$body

A single GroupMember object or an array of GroupMember objects, limited to the following attribute: email

Type: object

{
  "firstName" : "Group member's first name",
  "lastName" : "Group member's last name",
  "name" : "Group member's full name",
  "id" : "Group member's user Id",
  "email" : "Group member's email address"
}

columnId (required)

Type: string

rowId (required)

Type: string

sheetId (required)

Type: string

$body

Type: object

{ }

altText

url-encoded alternate text for the image

Type: string

overrideValidation

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.

Type: boolean

sheetId (required)

Type: string

$body

Row object or an array of Row objects, with the following attributes:

One or more location-specifier attributes (optional) expanded (optional) format (optional) cells (optional) -- if specified, must be an array of Cell objects, where each object is limited to the following attributes: columnId (required) One of the following (required): formula: for cross-sheet formulas, you must first define a cross-sheet reference value When value is specified hyperlink (optional) with exactly one of the following attributes set: reportId sheetId url linkInFromCell (optional) with all of the following attributes set: columnId rowId sheetId strict (optional) format (optional) image (optional) -- if specified, use to update alternate text where altText = string. overrideValidation (optional) locked (optional) - true to lock the row or false to unlock the row.See Column Types for more information.

NOTE: Column Ids must be valid for the sheet to which the row belongs, and must only be used once for each row in the operation. Cells of a project sheet in the "Finish Date" column cannot be updated via API. Cells of a project sheet in the "Start Date" column cannot be updated via API for rows that contain a value in the "Predecessor" column. Max length for a cell value is 4000 characters after which truncation occurs without warning. Empty string values are converted to null. 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".

Type: object

{
  "conditionalFormat" : "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" : [ {
    "createdAt" : "A timestamp of when the attachment was originally added",
    "attachmentSubType" : "Attachment sub type",
    "attachmentType" : "string. Possible values: BOX_COM | DROPBOX | EGNYTE | EVERNOTE | FILE | GOOGLE_DRIVE | LINK | ONEDRIVE",
    "createdBy" : { },
    "urlExpiresInMillis" : "Attachment temporary URL time to live (files only)",
    "name" : "Attachment name",
    "id" : "Attachment Id",
    "mimeType" : "Attachment MIME type (PNG, etc.)",
    "sizeInKb" : "The size of the file, if the attachmentType is FILE",
    "parentId" : "The Id of the parent",
    "parentType" : "The type of object the attachment belongs to",
    "url" : "Attachment temporary URL (files only)"
  } ],
  "indent" : "Specifies the number of levels to indent an existing row. You can specify this attribute in a request, but it is never present in a response.",
  "columns" : [ {
    "symbol" : "When applicable for CHECKBOX or PICKLIST column types.",
    "contactOptions" : [ {
      "name" : "Can be a user's name, display name, or free text, such as a job class or TBD.",
      "email" : "A parsable email address."
    } ],
    "hidden" : "Indicates whether the column is hidden",
    "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.",
    "description" : "Column description.",
    "index" : "Column index or position. This number is zero-based.",
    "type" : "string. Possible values: ABSTRACT_DATETIME | CHECKBOX | CONTACT_LIST | DATE | DATETIME | DURATION | MULTI_CONTACT_LIST | PICKLIST | PREDECESSOR | TEXT_NUMBER",
    "title" : "Column title",
    "version" : "A zero-based integer indicating whether the column allows multi-contact data. A value of 0 indicates the data will be stored as text and the column type will be TEXT_NUMBER, a value of 1 for sheets and reports or a value of 2 for Sights (aka dashboards) indicates the data will be stored as contacts and the column type will be MULTI_CONTACT_LIST. If not specified, the default value is 0 for sheets and reports or 1 for Sights (aka dashboards).",
    "tags" : [ "string. Possible values: CALENDAR_END_DATE | CALENDAR_START_DATE | GANTT_ALLOCATION | GANTT_ASSIGNED_RESOURCE | GANTT_DISPLAY_LABEL | GANTT_DURATION | GANTT_END_DATE | GANTT_PERCENT_COMPLETE | GANTT_PREDECESSOR | GANTT_START_DATE" ],
    "autoNumberFormat" : {
      "prefix" : "The prefix. Can include the date tokens:{YY}{YYYY}{MM}{DD}",
      "startingNumber" : "The starting number for the auto-id",
      "fill" : "Indicates zero-padding. Must be between 0 and 10 \"0\" (zero) characters.",
      "suffix" : "The suffix. Can include the date tokens:{YY}{YYYY}{MM}{DD}"
    },
    "options" : [ "string" ],
    "width" : "Display width of the column in pixels",
    "lockedForUser" : "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" : "string. Possible values: AUTO_NUMBER | CREATED_BY | CREATED_DATE | MODIFIED_BY | MODIFIED_DATE",
    "id" : "Column Id",
    "locked" : "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" : "Indicates whether validation has been enabled for the column (value = true)",
    "primary" : "Returned only if the column is the Primary Column (value = true)"
  } ],
  "modifiedAt" : "Time of last modification",
  "discussions" : [ {
    "commentAttachments" : [ {
      "createdAt" : "A timestamp of when the attachment was originally added",
      "attachmentSubType" : "Attachment sub type",
      "attachmentType" : "string. Possible values: BOX_COM | DROPBOX | EGNYTE | EVERNOTE | FILE | GOOGLE_DRIVE | LINK | ONEDRIVE",
      "createdBy" : { },
      "urlExpiresInMillis" : "Attachment temporary URL time to live (files only)",
      "name" : "Attachment name",
      "id" : "Attachment Id",
      "mimeType" : "Attachment MIME type (PNG, etc.)",
      "sizeInKb" : "The size of the file, if the attachmentType is FILE",
      "parentId" : "The Id of the parent",
      "parentType" : "The type of object the attachment belongs to",
      "url" : "Attachment temporary URL (files only)"
    } ],
    "comments" : [ {
      "createdAt" : "Time of creation",
      "attachments" : [ {
        "createdAt" : "A timestamp of when the attachment was originally added",
        "attachmentSubType" : "Attachment sub type",
        "attachmentType" : "string. Possible values: BOX_COM | DROPBOX | EGNYTE | EVERNOTE | FILE | GOOGLE_DRIVE | LINK | ONEDRIVE",
        "createdBy" : { },
        "urlExpiresInMillis" : "Attachment temporary URL time to live (files only)",
        "name" : "Attachment name",
        "id" : "Attachment Id",
        "mimeType" : "Attachment MIME type (PNG, etc.)",
        "sizeInKb" : "The size of the file, if the attachmentType is FILE",
        "parentId" : "The Id of the parent",
        "parentType" : "The type of object the attachment belongs to",
        "url" : "Attachment temporary URL (files only)"
      } ],
      "createdBy" : { },
      "discussionId" : "Discussion Id",
      "modifiedAt" : "Time of last modification",
      "id" : "Comment Id",
      "text" : "Comment body"
    } ],
    "accessLevel" : "User's permissions on the discussion",
    "createdBy" : { },
    "readOnly" : "Indicates whether the user can modify the discussion",
    "id" : "Discussion Id",
    "lastCommentedAt" : "Time of most recent comment",
    "title" : "Read Only. Discussion title automatically created by duplicating the first 100 characters of the top-level comment",
    "parentId" : "Id of the directly associated row or sheet: present only when the direct association is not clear (see List Discussions)",
    "parentType" : "string. Possible values: SHEET | ROW",
    "commentCount" : "The number of comments in the discussion",
    "lastCommentedUser" : {
      "lastLogin" : "Last login time of the current user",
      "lastName" : "User's last name",
      "customWelcomeScreenViewed" : "Timestamp of viewing an Enterprise Custom Welcome Screen by the current user",
      "admin" : "Indicates whether the user is a system admin (can manage user accounts and organization account)",
      "profileImage" : {
        "altText" : "Alternate text for the image",
        "width" : "Original width (in pixels) of the uploaded image",
        "resourceViewer" : "Indicates whether the user is a resource viewer (can access resource views)",
        "id" : "Image Id",
        "height" : "Original height (in pixels) of the uploaded image"
      },
      "firstName" : "User's first name",
      "groupAdmin" : "Indicates whether the user is a group admin (can create and edit groups)",
      "name" : "User's full name (read-only)",
      "id" : "User Id",
      "sheetCount" : "The number of sheets owned by the current user within the organization account",
      "email" : "User's primary email address",
      "licensedSheetCreator" : "Indicates whether the user is a licensed user (can create and own sheets)",
      "status" : "User status"
    }
  } ],
  "toBottom" : "Adds or moves the row to the bottom of the sheet. You can specify this attribute in a request, but it is never present in a response.",
  "toTop" : "Adds or moves the row to the top of the sheet. You can specify this attribute in a request, but it is never present in a response.",
  "createdAt" : "Time of creation",
  "expanded" : "Indicates whether the row is expanded or collapsed",
  "inCriticalPath" : "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",
  "above" : "Specifies the location for a new or moved row. You can specify this attribute in a request, but it is never present in a response.",
  "outdent" : "Specifies the number of levels to outdent an existing row. You can specify this attribute in a request, but it is never present in a response.",
  "modifiedBy" : {
    "lastLogin" : "Last login time of the current user",
    "lastName" : "User's last name",
    "customWelcomeScreenViewed" : "Timestamp of viewing an Enterprise Custom Welcome Screen by the current user",
    "admin" : "Indicates whether the user is a system admin (can manage user accounts and organization account)",
    "profileImage" : {
      "altText" : "Alternate text for the image",
      "width" : "Original width (in pixels) of the uploaded image",
      "resourceViewer" : "Indicates whether the user is a resource viewer (can access resource views)",
      "id" : "Image Id",
      "height" : "Original height (in pixels) of the uploaded image"
    },
    "firstName" : "User's first name",
    "groupAdmin" : "Indicates whether the user is a group admin (can create and edit groups)",
    "name" : "User's full name (read-only)",
    "id" : "User Id",
    "sheetCount" : "The number of sheets owned by the current user within the organization account",
    "email" : "User's primary email address",
    "licensedSheetCreator" : "Indicates whether the user is a licensed user (can create and own sheets)",
    "status" : "User status"
  },
  "id" : "Row Id",
  "locked" : "Indicates whether the row is locked. In a response, a value of true indicates that the row has been locked by the sheet owner or the admin.",
  "rowNumber" : "Row number within the sheet (1-based - starts at 1)",
  "accessLevel" : "User's permission level on the sheet that contains the row",
  "format" : "Format descriptor (see Formatting). Only returned if the include query string parameter contains format and this row has a non-default format applied.",
  "version" : "Sheet version number that is incremented every time a sheet is modified",
  "parentId" : "In a response - the Id of the parent row (if any). In a request - the Id of the desired parent row (used to specify the location for a new or moved row).",
  "cells" : [ {
    "conditionalFormat" : "The format descriptor describing this cell's conditional format (see Formatting). Only returned if the include query string parameter contains format and this cell has a conditional format applied.",
    "hyperlink" : { },
    "image" : { },
    "columnId" : "The Id of the column that the cell is located in",
    "format" : "The format descriptor. Only returned if the include query string parameter contains format and this cell has a non-default format applied.",
    "objectValue" : {
      "objectType" : "string. Possible values: ABSTRACT_DATETIME | CONTACT | DATE | DATETIME | DURATION | MULTI_CONTACT | PREDECESSOR_LIST"
    },
    "overrideValidation" : "(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" : "Visual representation of cell contents, as presented to the user in the UI.",
    "columnType" : "See type definition on the Column object. Only returned if the include query string parameter contains columnType.",
    "formula" : "The formula for a cell, if set. NOTE: 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" : "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. See Cell Value Parsing for more information about using this attribute.",
    "linkInFromCell" : {
      "sheetName" : "Sheet name of the linked cell",
      "columnId" : "Column Id of the linked cell",
      "sheetId" : "Sheet Id of the sheet that the linked cell belongs to",
      "rowId" : "Row Id of the linked cell",
      "status" : "string. Possible values: OK | BROKEN | INACCESSIBLE | BLOCKED | CIRCULAR | DISABLED | INVALID | NOT_SHARED"
    },
    "value" : { },
    "linksOutToCells" : [ {
      "sheetName" : "Sheet name of the linked cell",
      "columnId" : "Column Id of the linked cell",
      "sheetId" : "Sheet Id of the sheet that the linked cell belongs to",
      "rowId" : "Row Id of the linked cell",
      "status" : "string. Possible values: OK | BROKEN | INACCESSIBLE | BLOCKED | CIRCULAR | DISABLED | INVALID | NOT_SHARED"
    } ]
  } ],
  "createdBy" : { },
  "filteredOut" : "true if this row is filtered out by a column filter (and thus is not displayed in the Smartsheet app), false if the row is not filtered out. Only returned if the include query string parameter contains filters.",
  "sheetId" : "Parent sheet Id",
  "lockedForUser" : "Indicates whether the row is locked for the requesting user. This attribute may be present in a response, but cannot be specified in a request.",
  "permalink" : "URL that represents a direct link to the row in SmartsheetOnly returned if the include query string parameter contains rowPermalink.",
  "siblingId" : "In a response - the Id of the previous sibling row at the same hierarchical level of this row (if any). In a request - the Id of the desired sibling row (used to specify the location for a new or moved row)."
}

allowPartialSuccess

If true, allows bulk operations to process even if one or more operations are invalid for some reason.

Type: boolean

$body

User object with the following attributes: admin (required) email (required) licensedSheetCreator (required) firstName (optional) lastName (optional) groupAdmin (optional) resourceViewer (optional)

Type: object

{
  "lastLogin" : "Last login time of the current user",
  "lastName" : "User's last name",
  "customWelcomeScreenViewed" : "Timestamp of viewing an Enterprise Custom Welcome Screen by the current user",
  "admin" : "Indicates whether the user is a system admin (can manage user accounts and organization account)",
  "profileImage" : {
    "altText" : "Alternate text for the image",
    "width" : "Original width (in pixels) of the uploaded image",
    "resourceViewer" : "Indicates whether the user is a resource viewer (can access resource views)",
    "id" : "Image Id",
    "height" : "Original height (in pixels) of the uploaded image"
  },
  "firstName" : "User's first name",
  "groupAdmin" : "Indicates whether the user is a group admin (can create and edit groups)",
  "name" : "User's full name (read-only)",
  "id" : "User Id",
  "sheetCount" : "The number of sheets owned by the current user within the organization account",
  "email" : "User's primary email address",
  "licensedSheetCreator" : "Indicates whether the user is a licensed user (can create and own sheets)",
  "status" : "User status"
}

sendEmail

Indicate whether to send a welcome email.

Type: boolean

attachmentId (required)

Type: string

sheetId (required)

Type: string

$body

Type: object

{ }

commentId (required)

Type: string

sheetId (required)

Type: string

$body

Attachment object limited to the following attributes: attachmentSubType attachmentType description (applicable when attaching to sheet or row only) name url

Type: object

{
  "createdAt" : "A timestamp of when the attachment was originally added",
  "attachmentSubType" : "Attachment sub type",
  "attachmentType" : "string. Possible values: BOX_COM | DROPBOX | EGNYTE | EVERNOTE | FILE | GOOGLE_DRIVE | LINK | ONEDRIVE",
  "createdBy" : { },
  "urlExpiresInMillis" : "Attachment temporary URL time to live (files only)",
  "name" : "Attachment name",
  "id" : "Attachment Id",
  "mimeType" : "Attachment MIME type (PNG, etc.)",
  "sizeInKb" : "The size of the file, if the attachmentType is FILE",
  "parentId" : "The Id of the parent",
  "parentType" : "The type of object the attachment belongs to",
  "url" : "Attachment temporary URL (files only)"
}

rowId (required)

Type: string

sheetId (required)

Type: string

$body

Attachment object limited to the following attributes: attachmentSubType attachmentType description (applicable when attaching to sheet or row only) name url

Type: object

{
  "createdAt" : "A timestamp of when the attachment was originally added",
  "attachmentSubType" : "Attachment sub type",
  "attachmentType" : "string. Possible values: BOX_COM | DROPBOX | EGNYTE | EVERNOTE | FILE | GOOGLE_DRIVE | LINK | ONEDRIVE",
  "createdBy" : { },
  "urlExpiresInMillis" : "Attachment temporary URL time to live (files only)",
  "name" : "Attachment name",
  "id" : "Attachment Id",
  "mimeType" : "Attachment MIME type (PNG, etc.)",
  "sizeInKb" : "The size of the file, if the attachmentType is FILE",
  "parentId" : "The Id of the parent",
  "parentType" : "The type of object the attachment belongs to",
  "url" : "Attachment temporary URL (files only)"
}

sheetId (required)

Type: string

$body

Attachment object limited to the following attributes: attachmentSubType attachmentType description (applicable when attaching to sheet or row only) name url

Type: object

{
  "createdAt" : "A timestamp of when the attachment was originally added",
  "attachmentSubType" : "Attachment sub type",
  "attachmentType" : "string. Possible values: BOX_COM | DROPBOX | EGNYTE | EVERNOTE | FILE | GOOGLE_DRIVE | LINK | ONEDRIVE",
  "createdBy" : { },
  "urlExpiresInMillis" : "Attachment temporary URL time to live (files only)",
  "name" : "Attachment name",
  "id" : "Attachment Id",
  "mimeType" : "Attachment MIME type (PNG, etc.)",
  "sizeInKb" : "The size of the file, if the attachmentType is FILE",
  "parentId" : "The Id of the parent",
  "parentType" : "The type of object the attachment belongs to",
  "url" : "Attachment temporary URL (files only)"
}

sheetId (required)

Type: string

updateRequestId (required)

Type: string

$body

UpdateRequest object.

The UpdateRequest object in the request body must specify one or more of the following attributes: ccMe: Boolean columnIds: number[] includeAttachments: Boolean includeDiscussions: Boolean message: string schedule: Schedule object sendTo: Recipient[] subject: string

Type: object

{
  "createdAt" : "The date and time for when this request was originally created. Read-only.",
  "schedule" : {
    "dayOfMonth" : "The day within the month",
    "dayDescriptors" : [ "string. Possible values: DAY | WEEKDAY | WEEKEND | SUNDAY | MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY" ],
    "dayOrdinal" : "This attribute is applicable to the MONTHLY schedule type.",
    "lastSentAt" : "The date and time for when the last request was sent. Read-only.",
    "repeatEvery" : "Frequency on which the request is delivered. The unit is a function of the type attribute.",
    "type" : "Schedule type",
    "endAt" : "The date, time, and time zone at which the delivery schedule ends. It must be a valid ISO-8601 date and time with an offset (YYYY-MM-DDThh:mm:ssTZD).",
    "nextSendAt" : "The date and time for when the next request is scheduled to send. Read-only.",
    "startAt" : "The date, time, and time zone at which the delivery schedule ends. It must be a valid ISO-8601 date and time with an offset (YYYY-MM-DDThh:mm:ssTZD)."
  },
  "modifiedAt" : "The date and time for when the last change was made to this request. Read-only.",
  "id" : "Id of the update request.",
  "sentBy" : {
    "lastLogin" : "Last login time of the current user",
    "lastName" : "User's last name",
    "customWelcomeScreenViewed" : "Timestamp of viewing an Enterprise Custom Welcome Screen by the current user",
    "admin" : "Indicates whether the user is a system admin (can manage user accounts and organization account)",
    "profileImage" : {
      "altText" : "Alternate text for the image",
      "width" : "Original width (in pixels) of the uploaded image",
      "resourceViewer" : "Indicates whether the user is a resource viewer (can access resource views)",
      "id" : "Image Id",
      "height" : "Original height (in pixels) of the uploaded image"
    },
    "firstName" : "User's first name",
    "groupAdmin" : "Indicates whether the user is a group admin (can create and edit groups)",
    "name" : "User's full name (read-only)",
    "id" : "User Id",
    "sheetCount" : "The number of sheets owned by the current user within the organization account",
    "email" : "User's primary email address",
    "licensedSheetCreator" : "Indicates whether the user is a licensed user (can create and own sheets)",
    "status" : "User status"
  }
}

folderId (required)

Type: string

$body

ContainerDestination object

Type: object

{
  "newName" : "Name of the newly created object (when creating a copy of a Sheet, Folder, Sight, or Workspace). This attribute is not supported for \"move\" operations (that is, a moved Sheet, Folder, Sight, or Workspace retains its original name).",
  "destinationType" : "Type of the destination container (when copying or moving a Sheet or a Folder).",
  "destinationId" : "Id of the destination container (when copying or moving a Sheet or a Folder). Required if destinationType is \"folder\" or \"workspace\" If destinationType is \"home\", this value must be null."
}

include

a comma-separated list of elements to include in the response.

Type: array

[ "string. Possible values: attachments | cellLinks | data | discussions | forms | ruleRecipients | rules | shares | all" ]

skipRemap

comma-separated list of references to NOT re-map for the newly created folder.

Type: array

[ "string. Possible values: cellLinks | reports | sheetHyperlinks | sights" ]

sheetId (required)

Type: string

$body

CopyOrMoveRowDirective object

Type: object

{
  "rowIds" : [ "number" ],
  "to" : {
    "sheetId" : "Id of the destination sheet"
  }
}

ignoreRowsNotFound

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).

Type: boolean

include

comma-separated list of row elements to copy in addition to the cell data

Type: array

[ "string. Possible values: all | attachments | children" ]

sheetId (required)

Type: string

$body

ContainerDestination object

Type: object

{
  "newName" : "Name of the newly created object (when creating a copy of a Sheet, Folder, Sight, or Workspace). This attribute is not supported for \"move\" operations (that is, a moved Sheet, Folder, Sight, or Workspace retains its original name).",
  "destinationType" : "Type of the destination container (when copying or moving a Sheet or a Folder).",
  "destinationId" : "Id of the destination container (when copying or moving a Sheet or a Folder). Required if destinationType is \"folder\" or \"workspace\" If destinationType is \"home\", this value must be null."
}

exclude

a comma-separated list of elements to not include in the response.

Type: array

[ "string. Possible values: sheetHyperlinks" ]

include

a comma-separated list of elements to include in the response.

Type: array

[ "string. Possible values: attachments | cellLinks | data | discussions | forms | ruleRecipients | rules | shares | all" ]

sightId (required)

Type: string

$body

ContainerDestination object

Type: object

{
  "newName" : "Name of the newly created object (when creating a copy of a Sheet, Folder, Sight, or Workspace). This attribute is not supported for \"move\" operations (that is, a moved Sheet, Folder, Sight, or Workspace retains its original name).",
  "destinationType" : "Type of the destination container (when copying or moving a Sheet or a Folder).",
  "destinationId" : "Id of the destination container (when copying or moving a Sheet or a Folder). Required if destinationType is \"folder\" or \"workspace\" If destinationType is \"home\", this value must be null."
}

workspaceId (required)

Type: string

$body

ContainerDestination object, limited to the following attribute: newName (string) - required

Type: object

{
  "newName" : "Name of the newly created object (when creating a copy of a Sheet, Folder, Sight, or Workspace). This attribute is not supported for \"move\" operations (that is, a moved Sheet, Folder, Sight, or Workspace retains its original name).",
  "destinationType" : "Type of the destination container (when copying or moving a Sheet or a Folder).",
  "destinationId" : "Id of the destination container (when copying or moving a Sheet or a Folder). Required if destinationType is \"folder\" or \"workspace\" If destinationType is \"home\", this value must be null."
}

include

a comma-separated list of elements to include in the response.

Type: array

[ "string. Possible values: attachments | cellLinks | data | discussions | forms | ruleRecipients | rules | shares | all" ]

skipRemap

comma-separated list of references to NOT re-map for the newly created workspace.

Type: array

[ "string. Possible values: cellLinks | reports | sheetHyperlinks | sights" ]

sheetId (required)

Type: string

$body

CrossSheetReference object with the following attributes: sourceSheetId: sheetId for data source Either two or all of the following:endColumnId: Defines ending edge of range when specifying one or more columns. Must be used with startColumnId.endRowId: Defines ending edge of range when specifying one or more rows. Must be used with startRowId.startColumnId: Defines beginning edge of range when specifying one or more columns. Must be used with endColumnId.startRowId: Defines beginning edge of range when specifying one or more rows. Must be used with endRowId. name (optional): unique name for reference. If you omit this parameter, Smartsheet will autogenerate a name.

Type: object

{
  "startRowId" : "Defines beginning edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.",
  "startColumnId" : "Defines beginning edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.",
  "name" : "Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References.",
  "sourceSheetId" : "Sheet Id of source sheet.",
  "endColumnId" : "Defines ending edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.",
  "endRowId" : "Defines ending edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.",
  "id" : "Cross-sheet reference Id, guaranteed unique within referencing sheet.",
  "status" : "string. Possible values: OK | BLOCKED | BROKEN | CIRCULAR | DISABLED | INVALID/UNKNOWN | NOT_SHARED"
}

rowId (required)

Type: string

sheetId (required)

Type: string

$body

Discussion object with the following attribute: comment (Comment object),Request body should contain parts with the following names: discussion: JSON Discussion object with the following attributes:title (string), must be 100 characters in length or lesscomment (Comment object) file: (optional) file to attach to the new commentSee Multipart Uploads for more information on parts.

Type: object

{
  "commentAttachments" : [ {
    "createdAt" : "A timestamp of when the attachment was originally added",
    "attachmentSubType" : "Attachment sub type",
    "attachmentType" : "string. Possible values: BOX_COM | DROPBOX | EGNYTE | EVERNOTE | FILE | GOOGLE_DRIVE | LINK | ONEDRIVE",
    "createdBy" : { },
    "urlExpiresInMillis" : "Attachment temporary URL time to live (files only)",
    "name" : "Attachment name",
    "id" : "Attachment Id",
    "mimeType" : "Attachment MIME type (PNG, etc.)",
    "sizeInKb" : "The size of the file, if the attachmentType is FILE",
    "parentId" : "The Id of the parent",
    "parentType" : "The type of object the attachment belongs to",
    "url" : "Attachment temporary URL (files only)"
  } ],
  "comments" : [ {
    "createdAt" : "Time of creation",
    "attachments" : [ {
      "createdAt" : "A timestamp of when the attachment was originally added",
      "attachmentSubType" : "Attachment sub type",
      "attachmentType" : "string. Possible values: BOX_COM | DROPBOX | EGNYTE | EVERNOTE | FILE | GOOGLE_DRIVE | LINK | ONEDRIVE",
      "createdBy" : { },
      "urlExpiresInMillis" : "Attachment temporary URL time to live (files only)",
      "name" : "Attachment name",
      "id" : "Attachment Id",
      "mimeType" : "Attachment MIME type (PNG, etc.)",
      "sizeInKb" : "The size of the file, if the attachmentType is FILE",
      "parentId" : "The Id of the parent",
      "parentType" : "The type of object the attachment belongs to",
      "url" : "Attachment temporary URL (files only)"
    } ],
    "createdBy" : { },
    "discussionId" : "Discussion Id",
    "modifiedAt" : "Time of last modification",
    "id" : "Comment Id",
    "text" : "Comment body"
  } ],
  "accessLevel" : "User's permissions on the discussion",
  "createdBy" : { },
  "readOnly" : "Indicates whether the user can modify the discussion",
  "id" : "Discussion Id",
  "lastCommentedAt" : "Time of most recent comment",
  "title" : "Read Only. Discussion title automatically created by duplicating the first 100 characters of the top-level comment",
  "parentId" : "Id of the directly associated row or sheet: present only when the direct association is not clear (see List Discussions)",
  "parentType" : "string. Possible values: SHEET | ROW",
  "commentCount" : "The number of comments in the discussion",
  "lastCommentedUser" : {
    "lastLogin" : "Last login time of the current user",
    "lastName" : "User's last name",
    "customWelcomeScreenViewed" : "Timestamp of viewing an Enterprise Custom Welcome Screen by the current user",
    "admin" : "Indicates whether the user is a system admin (can manage user accounts and organization account)",
    "profileImage" : {
      "altText" : "Alternate text for the image",
      "width" : "Original width (in pixels) of the uploaded image",
      "resourceViewer" : "Indicates whether the user is a resource viewer (can access resource views)",
      "id" : "Image Id",
      "height" : "Original height (in pixels) of the uploaded image"
    },
    "firstName" : "User's first name",
    "groupAdmin" : "Indicates whether the user is a group admin (can create and edit groups)",
    "name" : "User's full name (read-only)",
    "id" : "User Id",
    "sheetCount" : "The number of sheets owned by the current user within the organization account",
    "email" : "User's primary email address",
    "licensedSheetCreator" : "Indicates whether the user is a licensed user (can create and own sheets)",
    "status" : "User status"
  }
}

sheetId (required)

Type: string

$body

Discussion object with the following attribute: comment (Comment object),Request body should contain parts with the following names: discussion: JSON Discussion object with the following attributes:title (string), must be 100 characters in length or lesscomment (Comment object) file: (optional) file to attach to the new commentSee Multipart Uploads for more information on parts.

Type: object

{
  "commentAttachments" : [ {
    "createdAt" : "A timestamp of when the attachment was originally added",
    "attachmentSubType" : "Attachment sub type",
    "attachmentType" : "string. Possible values: BOX_COM | DROPBOX | EGNYTE | EVERNOTE | FILE | GOOGLE_DRIVE | LINK | ONEDRIVE",
    "createdBy" : { },
    "urlExpiresInMillis" : "Attachment temporary URL time to live (files only)",
    "name" : "Attachment name",
    "id" : "Attachment Id",
    "mimeType" : "Attachment MIME type (PNG, etc.)",
    "sizeInKb" : "The size of the file, if the attachmentType is FILE",
    "parentId" : "The Id of the parent",
    "parentType" : "The type of object the attachment belongs to",
    "url" : "Attachment temporary URL (files only)"
  } ],
  "comments" : [ {
    "createdAt" : "Time of creation",
    "attachments" : [ {
      "createdAt" : "A timestamp of when the attachment was originally added",
      "attachmentSubType" : "Attachment sub type",
      "attachmentType" : "string. Possible values: BOX_COM | DROPBOX | EGNYTE | EVERNOTE | FILE | GOOGLE_DRIVE | LINK | ONEDRIVE",
      "createdBy" : { },
      "urlExpiresInMillis" : "Attachment temporary URL time to live (files only)",
      "name" : "Attachment name",
      "id" : "Attachment Id",
      "mimeType" : "Attachment MIME type (PNG, etc.)",
      "sizeInKb" : "The size of the file, if the attachmentType is FILE",
      "parentId" : "The Id of the parent",
      "parentType" : "The type of object the attachment belongs to",
      "url" : "Attachment temporary URL (files only)"
    } ],
    "createdBy" : { },
    "discussionId" : "Discussion Id",
    "modifiedAt" : "Time of last modification",
    "id" : "Comment Id",
    "text" : "Comment body"
  } ],
  "accessLevel" : "User's permissions on the discussion",
  "createdBy" : { },
  "readOnly" : "Indicates whether the user can modify the discussion",
  "id" : "Discussion Id",
  "lastCommentedAt" : "Time of most recent comment",
  "title" : "Read Only. Discussion title automatically created by duplicating the first 100 characters of the top-level comment",
  "parentId" : "Id of the directly associated row or sheet: present only when the direct association is not clear (see List Discussions)",
  "parentType" : "string. Possible values: SHEET | ROW",
  "commentCount" : "The number of comments in the discussion",
  "lastCommentedUser" : {
    "lastLogin" : "Last login time of the current user",
    "lastName" : "User's last name",
    "customWelcomeScreenViewed" : "Timestamp of viewing an Enterprise Custom Welcome Screen by the current user",
    "admin" : "Indicates whether the user is a system admin (can manage user accounts and organization account)",
    "profileImage" : {
      "altText" : "Alternate text for the image",
      "width" : "Original width (in pixels) of the uploaded image",
      "resourceViewer" : "Indicates whether the user is a resource viewer (can access resource views)",
      "id" : "Image Id",
      "height" : "Original height (in pixels) of the uploaded image"
    },
    "firstName" : "User's first name",
    "groupAdmin" : "Indicates whether the user is a group admin (can create and edit groups)",
    "name" : "User's full name (read-only)",
    "id" : "User Id",
    "sheetCount" : "The number of sheets owned by the current user within the organization account",
    "email" : "User's primary email address",
    "licensedSheetCreator" : "Indicates whether the user is a licensed user (can create and own sheets)",
    "status" : "User status"
  }
}

$body

Folder object, limited to the following attribute: name (string) - required, does not have to be unique

Type: object

{
  "reports" : [ {
    "sourceSheets" : [ { } ]
  } ],
  "sheets" : [ {
    "workspace" : { },
    "attachments" : [ {
      "createdAt" : "A timestamp of when the attachment was originally added",
      "attachmentSubType" : "Attachment sub type",
      "attachmentType" : "string. Possible values: BOX_COM | DROPBOX | EGNYTE | EVERNOTE | FILE | GOOGLE_DRIVE | LINK | ONEDRIVE",
      "createdBy" : { },
      "urlExpiresInMillis" : "Attachment temporary URL time to live (files only)",
      "name" : "Attachment name",
      "id" : "Attachment Id",
      "mimeType" : "Attachment MIME type (PNG, etc.)",
      "sizeInKb" : "The size of the file, if the attachmentType is FILE",
      "parentId" : "The Id of the parent",
      "parentType" : "The type of object the attachment belongs to",
      "url" : "Attachment temporary URL (files only)"
    } ],
    "columns" : [ {
      "symbol" : "When applicable for CHECKBOX or PICKLIST column types.",
      "contactOptions" : [ {
        "name" : "Can be a user's name, display name, or free text, such as a job class or TBD.",
        "email" : "A parsable email address."
      } ],
      "hidden" : "Indicates whether the column is hidden",
      "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.",
      "description" : "Column description.",
      "index" : "Column index or position. This number is zero-based.",
      "type" : "string. Possible values: ABSTRACT_DATETIME | CHECKBOX | CONTACT_LIST | DATE | DATETIME | DURATION | MULTI_CONTACT_LIST | PICKLIST | PREDECESSOR | TEXT_NUMBER",
      "title" : "Column title",
      "version" : "A zero-based integer indicating whether the column allows multi-contact data. A value of 0 indicates the data will be stored as text and the column type will be TEXT_NUMBER, a value of 1 for sheets and reports or a value of 2 for Sights (aka dashboards) indicates the data will be stored as contacts and the column type will be MULTI_CONTACT_LIST. If not specified, the default value is 0 for sheets and reports or 1 for Sights (aka dashboards).",
      "tags" : [ "string. Possible values: CALENDAR_END_DATE | CALENDAR_START_DATE | GANTT_ALLOCATION | GANTT_ASSIGNED_RESOURCE | GANTT_DISPLAY_LABEL | GANTT_DURATION | GANTT_END_DATE | GANTT_PERCENT_COMPLETE | GANTT_PREDECESSOR | GANTT_START_DATE" ],
      "autoNumberFormat" : {
        "prefix" : "The prefix. Can include the date tokens:{YY}{YYYY}{MM}{DD}",
        "startingNumber" : "The starting number for the auto-id",
        "fill" : "Indicates zero-padding. Must be between 0 and 10 \"0\" (zero) characters.",
        "suffix" : "The suffix. Can include the date tokens:{YY}{YYYY}{MM}{DD}"
      },
      "options" : [ "string" ],
      "width" : "Display width of the column in pixels",
      "lockedForUser" : "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" : "string. Possible values: AUTO_NUMBER | CREATED_BY | CREATED_DATE | MODIFIED_BY | MODIFIED_DATE",
      "id" : "Column Id",
      "locked" : "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" : "Indicates whether validation has been enabled for the column (value = true)",
      "primary" : "Returned only if the column is the Primary Column (value = true)"
    } ],
    "modifiedAt" : "Time that the sheet was modified",
    "discussions" : [ { } ],
    "source" : { },
    "ownerId" : "User Id of the sheet owner",
    "resourceManagementEnabled" : "Indicates that resource management is enabled",
    "ganttEnabled" : "Indicates whether \"Gantt View\" is enabled",
    "createdAt" : "Time that the sheet was created",
    "id" : "Sheet Id",
    "totalRowCount" : "The total number of rows in the sheet",
    "owner" : "Email address of the sheet owner",
    "accessLevel" : "User's permissions on the sheet",
    "readOnly" : "Returned only if the sheet belongs to an expired trial (value = true)",
    "rows" : [ {
      "conditionalFormat" : "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" : [ {
        "createdAt" : "A timestamp of when the attachment was originally added",
        "attachmentSubType" : "Attachment sub type",
        "attachmentType" : "string. Possible values: BOX_COM | DROPBOX | EGNYTE | EVERNOTE | FILE | GOOGLE_DRIVE | LINK | ONEDRIVE",
        "createdBy" : { },
        "urlExpiresInMillis" : "Attachment temporary URL time to live (files only)",
        "name" : "Attachment name",
        "id" : "Attachment Id",
        "mimeType" : "Attachment MIME type (PNG, etc.)",
        "sizeInKb" : "The size of the file, if the attachmentType is FILE",
        "parentId" : "The Id of the parent",
        "parentType" : "The type of object the attachment belongs to",
        "url" : "Attachment temporary URL (files only)"
      } ],
      "indent" : "Specifies the number of levels to indent an existing row. You can specify this attribute in a request, but it is never present in a response.",
      "columns" : [ {
        "symbol" : "When applicable for CHECKBOX or PICKLIST column types.",
        "contactOptions" : [ {
          "name" : "Can be a user's name, display name, or free text, such as a job class or TBD.",
          "email" : "A parsable email address."
        } ],
        "hidden" : "Indicates whether the column is hidden",
        "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.",
        "description" : "Column description.",
        "index" : "Column index or position. This number is zero-based.",
        "type" : "string. Possible values: ABSTRACT_DATETIME | CHECKBOX | CONTACT_LIST | DATE | DATETIME | DURATION | MULTI_CONTACT_LIST | PICKLIST | PREDECESSOR | TEXT_NUMBER",
        "title" : "Column title",
        "version" : "A zero-based integer indicating whether the column allows multi-contact data. A value of 0 indicates the data will be stored as text and the column type will be TEXT_NUMBER, a value of 1 for sheets and reports or a value of 2 for Sights (aka dashboards) indicates the data will be stored as contacts and the column type will be MULTI_CONTACT_LIST. If not specified, the default value is 0 for sheets and reports or 1 for Sights (aka dashboards).",
        "tags" : [ "string. Possible values: CALENDAR_END_DATE | CALENDAR_START_DATE | GANTT_ALLOCATION | GANTT_ASSIGNED_RESOURCE | GANTT_DISPLAY_LABEL | GANTT_DURATION | GANTT_END_DATE | GANTT_PERCENT_COMPLETE | GANTT_PREDECESSOR | GANTT_START_DATE" ],
        "autoNumberFormat" : {
          "prefix" : "The prefix. Can include the date tokens:{YY}{YYYY}{MM}{DD}",
          "startingNumber" : "The starting number for the auto-id",
          "fill" : "Indicates zero-padding. Must be between 0 and 10 \"0\" (zero) characters.",
          "suffix" : "The suffix. Can include the date tokens:{YY}{YYYY}{MM}{DD}"
        },
        "options" : [ "string" ],
        "width" : "Display width of the column in pixels",
        "lockedForUser" : "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" : "string. Possible values: AUTO_NUMBER | CREATED_BY | CREATED_DATE | MODIFIED_BY | MODIFIED_DATE",
        "id" : "Column Id",
        "locked" : "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" : "Indicates whether validation has been enabled for the column (value = true)",
        "primary" : "Returned only if the column is the Primary Column (value = true)"
      } ],
      "modifiedAt" : "Time of last modification",
      "discussions" : [ {
        "commentAttachments" : [ {
          "createdAt" : "A timestamp of when the attachment was originally added",
          "attachmentSubType" : "Attachment sub type",
          "attachmentType" : "string. Possible values: BOX_COM | DROPBOX | EGNYTE | EVERNOTE | FILE | GOOGLE_DRIVE | LINK | ONEDRIVE",
          "createdBy" : { },
          "urlExpiresInMillis" : "Attachment temporary URL time to live (files only)",
          "name" : "Attachment name",
          "id" : "Attachment Id",
          "mimeType" : "Attachment MIME type (PNG, etc.)",
          "sizeInKb" : "The size of the file, if the attachmentType is FILE",
          "parentId" : "The Id of the parent",
          "parentType" : "The type of object the attachment belongs to",
          "url" : "Attachment temporary URL (files only)"
        } ],
        "comments" : [ {
          "createdAt" : "Time of creation",
          "attachments" : [ {
            "createdAt" : "A timestamp of when the attachment was originally added",
            "attachmentSubType" : "Attachment sub type",
            "attachmentType" : "string. Possible values: BOX_COM | DROPBOX | EGNYTE | EVERNOTE | FILE | GOOGLE_DRIVE | LINK | ONEDRIVE",
            "createdBy" : { },
            "urlExpiresInMillis" : "Attachment temporary URL time to live (files only)",
            "name" : "Attachment name",
            "id" : "Attachment Id",
            "mimeType" : "Attachment MIME type (PNG, etc.)",
            "sizeInKb" : "The size of the file, if the attachmentType is FILE",
            "parentId" : "The Id of the parent",
            "parentType" : "The type of object the attachment belongs to",
            "url" : "Attachment temporary URL (files only)"
          } ],
          "createdBy" : { },
          "discussionId" : "Discussion Id",
          "modifiedAt" : "Time of last modification",
          "id" : "Comment Id",
          "text" : "Comment body"
        } ],
        "accessLevel" : "User's permissions on the discussion",
        "createdBy" : { },
        "readOnly" : "Indicates whether the user can modify the discussion",
        "id" : "Discussion Id",
        "lastCommentedAt" : "Time of most recent comment",
        "title" : "Read Only. Discussion title automatically created by duplicating the first 100 characters of the top-level comment",
        "parentId" : "Id of the directly associated row or sheet: present only when the direct association is not clear (see List Discussions)",
        "parentType" : "string. Possible values: SHEET | ROW",
        "commentCount" : "The number of comments in the discussion",
        "lastCommentedUser" : {
          "lastLogin" : "Last login time of the current user",
          "lastName" : "User's last name",
          "customWelcomeScreenViewed" : "Timestamp of viewing an Enterprise Custom Welcome Screen by the current user",
          "admin" : "Indicates whether the user is a system admin (can manage user accounts and organization account)",
          "profileImage" : {
            "altText" : "Alternate text for the image",
            "width" : "Original width (in pixels) of the uploaded image",
            "resourceViewer" : "Indicates whether the user is a resource viewer (can access resource views)",
            "id" : "Image Id",
            "height" : "Original height (in pixels) of the uploaded image"
          },
          "firstName" : "User's first name",
          "groupAdmin" : "Indicates whether the user is a group admin (can create and edit groups)",
          "name" : "User's full name (read-only)",
          "id" : "User Id",
          "sheetCount" : "The number of sheets owned by the current user within the organization account",
          "email" : "User's primary email address",
          "licensedSheetCreator" : "Indicates whether the user is a licensed user (can create and own sheets)",
          "status" : "User status"
        }
      } ],
      "toBottom" : "Adds or moves the row to the bottom of the sheet. You can specify this attribute in a request, but it is never present in a response.",
      "toTop" : "Adds or moves the row to the top of the sheet. You can specify this attribute in a request, but it is never present in a response.",
      "createdAt" : "Time of creation",
      "expanded" : "Indicates whether the row is expanded or collapsed",
      "inCriticalPath" : "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",
      "above" : "Specifies the location for a new or moved row. You can specify this attribute in a request, but it is never present in a response.",
      "outdent" : "Specifies the number of levels to outdent an existing row. You can specify this attribute in a request, but it is never present in a response.",
      "modifiedBy" : {
        "lastLogin" : "Last login time of the current user",
        "lastName" : "User's last name",
        "customWelcomeScreenViewed" : "Timestamp of viewing an Enterprise Custom Welcome Screen by the current user",
        "admin" : "Indicates whether the user is a system admin (can manage user accounts and organization account)",
        "profileImage" : {
          "altText" : "Alternate text for the image",
          "width" : "Original width (in pixels) of the uploaded image",
          "resourceViewer" : "Indicates whether the user is a resource viewer (can access resource views)",
          "id" : "Image Id",
          "height" : "Original height (in pixels) of the uploaded image"
        },
        "firstName" : "User's first name",
        "groupAdmin" : "Indicates whether the user is a group admin (can create and edit groups)",
        "name" : "User's full name (read-only)",
        "id" : "User Id",
        "sheetCount" : "The number of sheets owned by the current user within the organization account",
        "email" : "User's primary email address",
        "licensedSheetCreator" : "Indicates whether the user is a licensed user (can create and own sheets)",
        "status" : "User status"
      },
      "id" : "Row Id",
      "locked" : "Indicates whether the row is locked. In a response, a value of true indicates that the row has been locked by the sheet owner or the admin.",
      "rowNumber" : "Row number within the sheet (1-based - starts at 1)",
      "accessLevel" : "User's permission level on the sheet that contains the row",
      "format" : "Format descriptor (see Formatting). Only returned if the include query string parameter contains format and this row has a non-default format applied.",
      "version" : "Sheet version number that is incremented every time a sheet is modified",
      "parentId" : "In a response - the Id of the parent row (if any). In a request - the Id of the desired parent row (used to specify the location for a new or moved row).",
      "cells" : [ {
        "conditionalFormat" : "The format descriptor describing this cell's conditional format (see Formatting). Only returned if the include query string parameter contains format and this cell has a conditional format applied.",
        "hyperlink" : { },
        "image" : { },
        "columnId" : "The Id of the column that the cell is located in",
        "format" : "The format descriptor. Only returned if the include query string parameter contains format and this cell has a non-default format applied.",
        "objectValue" : {
          "objectType" : "string. Possible values: ABSTRACT_DATETIME | CONTACT | DATE | DATETIME | DURATION | MULTI_CONTACT | PREDECESSOR_LIST"
        },
        "overrideValidation" : "(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" : "Visual representation of cell contents, as presented to the user in the UI.",
        "columnType" : "See type definition on the Column object. Only returned if the include query string parameter contains columnType.",
        "formula" : "The formula for a cell, if set. NOTE: 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" : "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. See Cell Value Parsing for more information about using this attribute.",
        "linkInFromCell" : {
          "sheetName" : "Sheet name of the linked cell",
          "columnId" : "Column Id of the linked cell",
          "sheetId" : "Sheet Id of the sheet that the linked cell belongs to",
          "rowId" : "Row Id of the linked cell",
          "status" : "string. Possible values: OK | BROKEN | INACCESSIBLE | BLOCKED | CIRCULAR | DISABLED | INVALID | NOT_SHARED"
        },
        "value" : { },
        "linksOutToCells" : [ {
          "sheetName" : "Sheet name of the linked cell",
          "columnId" : "Column Id of the linked cell",
          "sheetId" : "Sheet Id of the sheet that the linked cell belongs to",
          "rowId" : "Row Id of the linked cell",
          "status" : "string. Possible values: OK | BROKEN | INACCESSIBLE | BLOCKED | CIRCULAR | DISABLED | INVALID | NOT_SHARED"
        } ]
      } ],
      "createdBy" : { },
      "filteredOut" : "true if this row is filtered out by a column filter (and thus is not displayed in the Smartsheet app), false if the row is not filtered out. Only returned if the include query string parameter contains filters.",
      "sheetId" : "Parent sheet Id",
      "lockedForUser" : "Indicates whether the row is locked for the requesting user. This attribute may be present in a response, but cannot be specified in a request.",
      "permalink" : "URL that represents a direct link to the row in SmartsheetOnly returned if the include query string parameter contains rowPermalink.",
      "siblingId" : "In a response - the Id of the previous sibling row at the same hierarchical level of this row (if any). In a request - the Id of the desired sibling row (used to specify the location for a new or moved row)."
    } ],
    "fromId" : "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" : "A number that is incremented every time a sheet is modified",
    "effectiveAttachmentOptions" : [ "string" ],
    "dependenciesEnabled" : "Indicates whether dependencies are enabled",
    "showParentRowsForFilters" : "Returned only if there are column filters on the sheet. Value = true if \"show parent rows\" is enabled for the filters.",
    "userSettings" : {
      "criticalPathEnabled" : "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" : "Does this user have \"Display Summary Tasks\" turned on for this sheet? Applies only to sheets where \"Calendar View\" has been configured."
    },
    "crossSheetReferences" : [ {
      "startRowId" : "Defines beginning edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.",
      "startColumnId" : "Defines beginning edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.",
      "name" : "Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References.",
      "sourceSheetId" : "Sheet Id of source sheet.",
      "endColumnId" : "Defines ending edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.",
      "endRowId" : "Defines ending edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.",
      "id" : "Cross-sheet reference Id, guaranteed unique within referencing sheet.",
      "status" : "string. Possible values: OK | BLOCKED | BROKEN | CIRCULAR | DISABLED | INVALID/UNKNOWN | NOT_SHARED"
    } ],
    "name" : "Sheet name",
    "permalink" : "URL that represents a direct link to the sheet in Smartsheet",
    "favorite" : "Returned only if the user has marked this sheet as a favorite in their Home tab (value = true)",
    "projectSettings" : {
      "nonWorkingDays" : [ "string" ],
      "workingDays" : [ "string. Possible values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY" ],
      "lengthOfDay" : "Length of a workday for a project sheet. Valid value must be above or equal to 1 hour, and less than or equal to 24 hours."
    }
  } ],
  "folders" : [ { } ],
  "sights" : [ {
    "createdAt" : "Time of creation",
    "backgroundColor" : "The hex color, for instance #E6F5FE",
    "workspace" : {
      "reports" : [ { } ],
      "sheets" : [ { } ],
      "folders" : [ { } ],
      "sights" : [ { } ],
      "accessLevel" : "User's permissions on the workspace",
      "templates" : [ { } ],
      "name" : "Workspace name",
      "id" : "Workspace Id",
      "permalink" : "URL that represents a direct link to the workspace in Smartsheet",
      "favorite" : "Returned only if the user has marked the workspace as a favorite in their \"Home\" tab (value = true)"
    },
    "accessLevel" : "User's permissions on the Sight.",
    "modifiedAt" : "Time of last modification",
    "name" : "Sight name",
    "id" : "Sight Id",
    "columnCount" : "Number of columns that the Sight contains",
    "permalink" : "URL that represents a direct link to the Sight in Smartsheet",
    "widgets" : [ {
      "showTitleIcon" : "True indicates that the client should display the sheet icon in the widget title",
      "xPosition" : "X-coordinate of widget's position on the Sight",
      "Rich Text" : {
        "html" : "The widget content as HTML. The Rich Text widget supports the following subset of HTML tags and CSS Styles: HTML: a - defines a hyperlink, br - inserts a single line break, li - defines a list item, ol - defines an ordered list, p - defines a paragraph, ul - defines an unordered list, span - defines a section in a document. CSS: color, font-family, font-size, font-style, font-weight, text-align, text-decoration."
      },
      "Report" : {
        "hyperlink" : {
          "reportId" : "If non-null, this hyperlink is a link to the report with this Id.",
          "sheetId" : "If non-null, this hyperlink is a link to the sheet with this Id.",
          "sightId" : "If non-null, this hyperlink is a link to the Sight with this Id.",
          "url" : "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a sheet/report/Sight link (that is, sheetId, reportId, or sightId is non-null), this property contains the permalink to the sheet, report, or Sight."
        },
        "reportId" : "Report Id denoting container source",
        "htmlContent" : "HTML snippet to render report"
      },
      "yPosition" : "Y-coordinate of widget's position on the Sight",
      "Title" : {
        "backgroundColor" : "The hex color, for instance #E6F5FE",
        "htmlContent" : "HTML snippet to render title"
      },
      "type" : "Type of widget. See table below to see how UI widget names map to type.",
      "title" : "Title of the widget",
      "viewMode" : "1 indicates content is centered. 2 indicates content is left aligned. Must use a query parameter of level=2 to see this information.",
      "Image" : {
        "hyperlink" : {
          "reportId" : "If non-null, this hyperlink is a link to the report with this Id.",
          "sheetId" : "If non-null, this hyperlink is a link to the sheet with this Id.",
          "sightId" : "If non-null, this hyperlink is a link to the Sight with this Id.",
          "url" : "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a sheet/report/Sight link (that is, sheetId, reportId, or sightId is non-null), this property contains the permalink to the sheet, report, or Sight."
        },
        "fileName" : "Name of the image file",
        "privateId" : "The image private Id",
        "format" : "formatDescriptor",
        "width" : "Original width of the image in pixels",
        "height" : "Original height of the image in pixels"
      },
      "version" : "Widget version number",
      "titleFormat" : "FormatDescriptor",
      "contents" : { },
      "showTitle" : "True indicates that the client should display the widget title. NOTE: This is independent of the title string which may be null or empty.",
      "Shortcut" : {
        "shortcutData" : [ {
          "hyperlink" : {
            "reportId" : "If non-null, this hyperlink is a link to the report with this Id.",
            "sheetId" : "If non-null, this hyperlink is a link to the sheet with this Id.",
            "sightId" : "If non-null, this hyperlink is a link to the Sight with this Id.",
            "url" : "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a sheet/report/Sight link (that is, sheetId, reportId, or sightId is non-null), this property contains the permalink to the sheet, report, or Sight."
          },
          "attachmentType" : "Attachment type",
          "labelFormat" : "formatDescriptor",
          "label" : "Label for the data point",
          "mimeType" : "MIME type if available for attachment type",
          "order" : "The display order for the ShortcutWidgetItem object"
        } ]
      },
      "Web Content" : {
        "url" : "The URL"
      },
      "width" : "Number of columns that the widget occupies on the Sight",
      "Metric" : {
        "hyperlink" : {
          "reportId" : "If non-null, this hyperlink is a link to the report with this Id.",
          "sheetId" : "If non-null, this hyperlink is a link to the sheet with this Id.",
          "sightId" : "If non-null, this hyperlink is a link to the Sight with this Id.",
          "url" : "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a sheet/report/Sight link (that is, sheetId, reportId, or sightId is non-null), this property contains the permalink to the sheet, report, or Sight."
        },
        "columns" : [ {
          "symbol" : "When applicable for CHECKBOX or PICKLIST column types.",
          "contactOptions" : [ {
            "name" : "Can be a user's name, display name, or free text, such as a job class or TBD.",
            "email" : "A parsable email address."
          } ],
          "hidden" : "Indicates whether the column is hidden",
          "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.",
          "description" : "Column description.",
          "index" : "Column index or position. This number is zero-based.",
          "type" : "string. Possible values: ABSTRACT_DATETIME | CHECKBOX | CONTACT_LIST | DATE | DATETIME | DURATION | MULTI_CONTACT_LIST | PICKLIST | PREDECESSOR | TEXT_NUMBER",
          "title" : "Column title",
          "version" : "A zero-based integer indicating whether the column allows multi-contact data. A value of 0 indicates the data will be stored as text and the column type will be TEXT_NUMBER, a value of 1 for sheets and reports or a value of 2 for Sights (aka dashboards) indicates the data will be stored as contacts and the column type will be MULTI_CONTACT_LIST. If not specified, the default value is 0 for sheets and reports or 1 for Sights (aka dashboards).",
          "tags" : [ "string. Possible values: CALENDAR_END_DATE | CALENDAR_START_DATE | GANTT_ALLOCATION | GANTT_ASSIGNED_RESOURCE | GANTT_DISPLAY_LABEL | GANTT_DURATION | GANTT_END_DATE | GANTT_PERCENT_COMPLETE | GANTT_PREDECESSOR | GANTT_START_DATE" ],
          "autoNumberFormat" : {
            "prefix" : "The prefix. Can include the date tokens:{YY}{YYYY}{MM}{DD}",
            "startingNumber" : "The starting number for the auto-id",
            "fill" : "Indicates zero-padding. Must be between 0 and 10 \"0\" (zero) characters.",
            "suffix" : "The suffix. Can include the date tokens:{YY}{YYYY}{MM}{DD}"
          },
          "options" : [ "string" ],
          "width" : "Display width of the column in pixels",
          "lockedForUser" : "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" : "string. Possible values: AUTO_NUMBER | CREATED_BY | CREATED_DATE | MODIFIED_BY | MODIFIED_DATE",
          "id" : "Column Id",
          "locked" : "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" : "Indicates whether validation has been enabled for the column (value = true)",
          "primary" : "Returned only if the column is the Primary Column (value = true)"
        } ],
        "sheetId" : "The Id of the sheet from which the cell data originates",
        "cellData" : [ {
          "labelFormat" : "formatDescriptor",
          "columnId" : "Column Id for each item",
          "valueFormat" : "formatDescriptor",
          "sheetId" : "Sheet Id for each item",
          "objectValue" : { },
          "label" : "Label for the data point. This is either the column name or a user-provided string",
          "cell" : {
            "conditionalFormat" : "The format descriptor describing this cell's conditional format (see Formatting). Only returned if the include query string parameter contains format and this cell has a conditional format applied.",
            "hyperlink" : { },
            "image" : { },
            "columnId" : "The Id of the column that the cell is located in",
            "format" : "The format descriptor. Only returned if the include query string parameter contains format and this cell has a non-default format applied.",
            "objectValue" : {
              "objectType" : "string. Possible values: ABSTRACT_DATETIME | CONTACT | DATE | DATETIME | DURATION | MULTI_CONTACT | PREDECESSOR_LIST"
            },
            "overrideValidation" : "(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" : "Visual representation of cell contents, as presented to the user in the UI.",
            "columnType" : "See type definition on the Column object. Only returned if the include query string parameter contains columnType.",
            "formula" : "The formula for a cell, if set. NOTE: 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" : "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. See Cell Value Parsing for more information about using this attribute.",
            "linkInFromCell" : {
              "sheetName" : "Sheet name of the linked cell",
              "columnId" : "Column Id of the linked cell",
              "sheetId" : "Sheet Id of the sheet that the linked cell belongs to",
              "rowId" : "Row Id of the linked cell",
              "status" : "string. Possible values: OK | BROKEN | INACCESSIBLE | BLOCKED | CIRCULAR | DISABLED | INVALID | NOT_SHARED"
            },
            "value" : { },
            "linksOutToCells" : [ {
              "sheetName" : "Sheet name of the linked cell",
              "columnId" : "Column Id of the linked cell",
              "sheetId" : "Sheet Id of the sheet that the linked cell belongs to",
              "rowId" : "Row Id of the linked cell",
              "status" : "string. Possible values: OK | BROKEN | INACCESSIBLE | BLOCKED | CIRCULAR | DISABLED | INVALID | NOT_SHARED"
            } ]
          },
          "dataSource" : "CELL",
          "rowId" : "Row Id for each item",
          "order" : "The display order for the CellDataItem"
        } ]
      },
      "id" : "Widget Id",
      "Chart" : {
        "hyperlink" : {
          "reportId" : "If non-null, this hyperlink is a link to the report with this Id.",
          "sheetId" : "If non-null, this hyperlink is a link to the sheet with this Id.",
          "sightId" : "If non-null, this hyperlink is a link to the Sight with this Id.",
          "url" : "When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a sheet/report/Sight link (that is, sheetId, reportId, or sightId is non-null), this property contains the permalink to the sheet, report, or Sight."
        },
        "reportId" : "Report Id denoting container source, if applicable",
        "legend" : "The location in the widget where Smartsheet renders the legend, for example, RIGHT",
        "series" : [ { } ],
        "axes" : [ { } ],
        "sheetId" : "Sheet Id denoting container source, if applicable",
        "includedColumnIds" : [ "number" ],
        "selectionRanges" : [ {
          "sourceRowId2" : "Defines ending edge of range when specifying one or more rows.",
          "sourceColumnId2" : "Defines ending edge of range when specifying one or more columns.",
          "sourceRowId1" : "Defines beginning edge of range when specifying one or more rows.",
          "sourceColumnId1" : "Defines beginning edge of range when specifying one or more columns."
        } ]
      },
      "height" : "Number of rows that the widget occupies on the Sight"
    } ],
    "favorite" : "Indicates whether the user has marked the Sight as a favorite"
  } ],
  "templates" : [ {
    "globalTemplate" : "Type of global template. Only applicable to blank public templates.",
    "image" : "URL to the small preview image for this template. Only applicable to non-blank public templates.",
    "largeImage" : "URL to the large preview image for this template. Only applicable to non-blank public templates.",
    "blank" : "Indicates whether the template is blank. Only applicable to public templates",
    "accessLevel" : "User's permissions on the template",
    "name" : "Template name",
    "description" : "Template description",
    "id" : "Template Id",
    "categories" : [ "string" ],
    "type" : "Type of the template. Only applicable to public templates.",
    "locale" : "Locale of the template.Only applicable to public templates.",
    "tags" : [ "string" ]
  } ],
  "name" : "Folder name",
  "id" : "Folder Id",
  "permalink" : "URL that represents a direct link to the folder in Smartsheet",
  "favorite" : "Returned only if the user has marked the folder as a favorite in their \"Home\" tab (value = true)"
}