Smartsheet logo

Objects

Sheet Object

id
number

Sheet Id.

fromId
number

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.

ownerId
number

User Id of the sheet owner.

accessLevel
string
Enum: "ADMIN" "COMMENTER" "EDITOR" "EDITOR_SHARE" "OWNER" "VIEWER"
Array of objects

Array of Attachment objects. Only returned if the include query string parameter contains attachments.

cellImageUploadEnabled
boolean

The sheet is enabled for cell images to be uploaded.

Array of objects
string or number
Array of objects

Array of CrossSheetReference objects. Only returned if the include query string parameter contains crossSheetReferences.

dependenciesEnabled
boolean

Indicates whether dependencies are enabled.

Array of objects

Array of Discussion objects Only returned if the include query string parameter contains discussions.

effectiveAttachmentOptions
Array of strings

Array of enum strings (see Attachment.attachmentType indicating the allowable attachment options for the current user and sheet.

favorite
boolean

(Deprecated) Returned only if the user has marked this sheet as a favorite in their Home tab (value = true).

ganttEnabled
boolean

Indicates whether "Gantt View" is enabled.

hasSummaryFields
boolean

Indicates whether a sheet summary is present.

isMultiPicklistEnabled
boolean

Indicates whether multi-select is enabled.

string or number
name
string

Sheet name.

owner
string

Email address of the sheet owner.

permalink
string

URL that represents a direct link to the sheet in Smartsheet.

object

Represents the project settings dependencies for a specific sheet. Project settings may be updated on sheets that the user has editor access.

readOnly
boolean

Returned only if the sheet belongs to an expired trial (value = true).

resourceManagementEnabled
boolean

Indicates that resource management is enabled.

resourceManagementType
string

Resource Management type. Indicates the type of RM that is enabled.

Enum: "NONE" "LEGACY_RESOURCE_MANAGEMENT" "RESOURCE_MANAGEMENT_BY_SMARTSHEET"
Array of objects
showParentRowsForFilters
boolean

Returned only if there are column filters on the sheet. Value = true if "show parent rows" is enabled for the filters.

object
object

Represents the entire summary, or a list of defined fields and values, for a specific sheet.

totalRowCount
number

The total number of rows in the sheet.

object

Describes the current user's editing permissions for a specific sheet.

object

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

version
number

A number that is incremented every time a sheet is modified.

object

Can contain dashboards, folders, reports, sheets, and templates.

{
  • "id": 0,
  • "fromId": 0,
  • "ownerId": 0,
  • "accessLevel": "ADMIN",
  • "attachments": [
    ],
  • "cellImageUploadEnabled": true,
  • "columns": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "crossSheetReferences": [
    ],
  • "dependenciesEnabled": true,
  • "discussions": [
    ],
  • "effectiveAttachmentOptions": [
    ],
  • "favorite": true,
  • "ganttEnabled": true,
  • "hasSummaryFields": true,
  • "isMultiPicklistEnabled": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "owner": "string",
  • "permalink": "string",
  • "projectSettings": {
    },
  • "readOnly": true,
  • "resourceManagementEnabled": true,
  • "resourceManagementType": "NONE",
  • "rows": [
    ],
  • "showParentRowsForFilters": true,
  • "source": {
    },
  • "summary": {
    },
  • "totalRowCount": 0,
  • "userPermissions": {
    },
  • "userSettings": {
    },
  • "version": 0,
  • "workspace": {
    }
}

Criteria Object

columnId
number

Column Id.

operator
string

Operator used to filter column values.

Enum: "BETWEEN" "CONTAINS" "EQUAL" "FUTURE" "GREATER_THAN" "HAS_ATTACHMENTS" "HAS_COMMENTS" "IS_BLANK" "IS_CHECKED" "IS_DATE" "IS_LOCKED" "IS_NUMBER" "IS_NOT_BLANK" "IS_NOT_CHECKED" "IS_NOT_DATE" "IS_NOT_NUMBER" "LAST_N_DAYS" "LESS_THAN" "NEXT_N_DAYS" "NO_ATTACHMENTS" "NO_COMMENTS" "NOT_EQUAL" "NOT_LOCKED" "NOT_ON_CRITICAL_PATH" "ON_CRITICAL_PATH" "PAST" "TODAY"
values
Array of strings

Present if a custom filter criteria's operator has one or more arguments.

{
  • "columnId": 293452983475,
  • "operator": "IS_ONE_OF",
  • "values": [
    ]
}

Filters Object

id
number

Filters Id.

excludeSelected
boolean

If true, rows containing cells matching the values or criteria items are excluded instead of included.

filterType
string
Enum: "PERSONAL" "SHARED"
object
{
  • "id": 52739485234,
  • "excludeSelected": false,
  • "filterType": "PERSONAL",
  • "query": {
    }
}

ProjectSettings Object

lengthOfDay
number [ 1 .. 24 ]

Length of a workday for a project sheet.

nonWorkingDays
Array of strings <date>

Non-working days for a project sheet.

workingDays
Array of strings
Items Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY"
{
  • "lengthOfDay": 1,
  • "nonWorkingDays": [
    ],
  • "workingDays": [
    ]
}

SheetPublish Object

icalEnabled
boolean

If true, a webcal is available for the calendar in the sheet.

icalUrl
any

URL for iCal view of the published sheet. Only returned in a response if icalEnabled = true.

readOnlyFullAccessibleBy
string

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.

Enum: "ALL" "ORG" "SHARED"
readOnlyFullDefaultView
string

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.

Enum: "CALENDAR" "CARD" "GRID"
readOnlyFullEnabled
boolean

If true, a rich version of the sheet is published with the ability to download 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.

readOnlyFullUrl
string

URL for 'Read-Only Full' view of the published sheet. Only returned in a response if **readOnlyFullEnabled = true.

readOnlyLiteEnabled
boolean

If true, a lightweight version of the sheet is published without row attachments and discussions.

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.

readWriteAccessibleBy
string

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.

Enum: "ALL" "ORG" "SHARED"
readWriteDefaultView
string

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.

Enum: "CALENDAR" "CARD" "GRID"
readWriteEnabled
boolean

If true,a rich version of the sheet is published with the ability to edit cells and manage attachments and discussions.

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.

readWriteUrl
string

URL for 'Edit by Anyone' view of the published sheet. Only returned in a response if readWriteEnabled = true.

{
  • "icalEnabled": true,
  • "icalUrl": null,
  • "readOnlyFullAccessibleBy": "ALL",
  • "readOnlyFullDefaultView": "CALENDAR",
  • "readOnlyFullEnabled": true,
  • "readOnlyFullShowToolbar": true,
  • "readOnlyFullUrl": "string",
  • "readOnlyLiteEnabled": true,
  • "readOnlyLiteSslUrl": "string",
  • "readOnlyLiteUrl": "string",
  • "readWriteAccessibleBy": "ALL",
  • "readWriteDefaultView": "CALENDAR",
  • "readWriteEnabled": true,
  • "readWriteShowToolbar": true,
  • "readWriteUrl": "string"
}

SheetUserPermissions Object

summaryPermissions
string

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.
Enum: "ADMIN" "READ_DELETE" "READ_ONLY" "READ_WRITE"
{
  • "summaryPermissions": "ADMIN"
}

SheetUserSettings Object

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.

{
  • "criticalPathEnabled": true,
  • "displaySummaryTasks": true
}

SortCriterion Object

columnId
number
direction
string
Default: "ASCENDING"

Direction of the sort.

Enum: "ASCENDING" "DESCENDING"
{
  • "columnId": 0,
  • "direction": "ASCENDING"
}

SortSpecifier Object

Array of objects

Specifies sort order. Array is in priority order.

{
  • "sortCriteria": [
    ]
}

Source Object

id
number

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.

{
  • "id": 0,
  • "type": "string"
}
➔ Next to Methods