# List contents (deprecated)

Gets a nested list of all Home objects shared to the user, including 
dashboards, folders, reports, sheets, and templates, as shown on the "Home"
tab.

DEPRECATED - This endpoint is being removed. To adapt to this change, please see Migrate from using the Sheets folder.

Endpoint: GET /folders/personal
Version: 2.0.0
Security: APIToken, OAuth2

## Header parameters:

  - `Authorization` (string)
    API Access Token used to authenticate requests to Smartsheet APIs.

  - `smartsheet-integration-source` (string)
    Uses the following metadata to distinguish between human-initiated API requests and third-party service-initiated calls by AI Connectors or ITSM:

- Integration source type
- Organization name
- Integration source name 

Format:


TYPE,OrgName,SourceName


Examples: 

AI,SampleOrg,My-AI-Connector-v2

SCRIPT,SampleOrg2,Accounting-updater-script

APPLICATION,SampleOrg3,SheetUpdater
    Example: "AI,SampleOrg,My-AI-Connector-v2"

## Query parameters:

  - `include` (string)
    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
    Enum: "source", "distributionLink", "ownerInfo", "sheetVersion"

## Response 200 fields (application/json):

  - `folders` (array)

  - `folders.id` (number)
    Folder ID.

  - `folders.folders` (array)
    Folders contained in folder.

  - `folders.name` (string)
    Folder name.

  - `folders.permalink` (string)
    URL that represents a direct link to the folder in Smartsheet.

  - `folders.reports` (array)
    Reports contained in folder.

  - `folders.reports.id` (number)
    Asset ID.

  - `folders.reports.name` (string)
    Asset name.

  - `folders.reports.permalink` (string)
    URL that represents a direct link to the asset in Smartsheet.

  - `folders.sheets` (array)
    Sheets contained in folder.

  - `folders.sights` (array)
    Dashboards contained in folder.

  - `folders.sights.createdAt` (any)

  - `folders.sights.modifiedAt` (any)

  - `folders.templates` (array)
    Templates contained in folder.

  - `folders.favorite` (boolean)
    Deprecated Returned only if the user has marked the folder as a favorite in their "Home" tab (value = true).

  - `reports` (array)

  - `reports.scope` (object)

  - `reports.scope.sheets` (array)
    Array of Sheet objects (containing just the sheet ID) of any sheets that the requester has access to that make up the report.

  - `reports.scope.sheets.id` (number)
    Sheet ID.

  - `reports.scope.sheets.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.

  - `reports.scope.sheets.ownerId` (number)
    User ID of the sheet owner.

  - `reports.scope.sheets.accessLevel` (string)
    Enum: "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER"

  - `reports.scope.sheets.attachments` (array)
    Array of Attachment objects.
Only returned if the [include](/api/smartsheet/openapi/sheets/getsheet) query string parameter contains attachments.

  - `reports.scope.sheets.attachments.id` (number)
    Attachment ID.

  - `reports.scope.sheets.attachments.parentId` (number)
    The ID of the parent.

  - `reports.scope.sheets.attachments.attachmentType` (string)
    Attachment type. Note--Dropbox, Egnyte, and Evernote are not supported for Smartsheet.gov accounts.
    Enum: "BOX_COM", "DROPBOX", "EGNYTE", "EVERNOTE", "FILE", "GOOGLE_DRIVE", "LINK", "ONEDRIVE", "TRELLO"

  - `reports.scope.sheets.attachments.attachmentSubType` (string)
    Attachment sub type. Note--Folder type is for EGNYTE values and the rest are GOOGLE_DRIVE values.
    Enum: "DOCUMENT", "DRAWING", "FOLDER", "PDF", "PRESENTATION", "SPREADSHEET"

  - `reports.scope.sheets.attachments.mimeType` (string)
    Attachment MIME type.
    Example: "PNG"

  - `reports.scope.sheets.attachments.parentType` (string)
    The type of object the attachment belongs to.
    Enum: "COMMENT", "PROOF", "ROW", "SHEET"

  - `reports.scope.sheets.attachments.createdBy` (object)
    User object containing name and email of the user who created this attachment.

  - `reports.scope.sheets.attachments.createdBy.email` (string)
    Example: "jane.doe@smartsheet.com"

  - `reports.scope.sheets.attachments.createdBy.name` (string)
    Example: "Jane Doe"

  - `reports.scope.sheets.attachments.name` (string)
    Attachment name.

  - `reports.scope.sheets.attachments.sizeInKb` (number)
    The size of the file, if the attachmentType is FILE.

  - `reports.scope.sheets.attachments.url` (string)
    Attachment temporary URL (files only).

  - `reports.scope.sheets.attachments.urlExpiresInMillis` (number)
    Attachment temporary URL time to live (files only).

  - `reports.scope.sheets.cellImageUploadEnabled` (boolean)
    The sheet is enabled for cell images to be uploaded.

  - `reports.scope.sheets.columns` (array)

  - `reports.scope.sheets.columns.autoNumberFormat` (object)
    Object that describes how the the System Column type of "AUTO_NUMBER" is auto-generated.

  - `reports.scope.sheets.columns.autoNumberFormat.fill` (string)
    Indicates zero-padding. Must be between 0 and 10 "0" (zero) characters.

  - `reports.scope.sheets.columns.autoNumberFormat.prefix` (string)
    The prefix. Can include the date tokens:
  * {DD}
  * {MM}
  * {YY}
  * {YYYY}

  - `reports.scope.sheets.columns.autoNumberFormat.startingNumber` (number)
    The starting number for the auto-id.

  - `reports.scope.sheets.columns.autoNumberFormat.suffix` (string)
    The suffix. Can include the date tokens:
  * {DD}
  * {MM}
  * {YY}
  * {YYYY}

  - `reports.scope.sheets.columns.contactOptions` (array)
    Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST.

  - `reports.scope.sheets.columns.contactOptions.email` (string)
    A parsable email address.

  - `reports.scope.sheets.columns.contactOptions.name` (string)
    Can be a user's name, display name, or free text.

  - `reports.scope.sheets.columns.description` (string)
    Column description.

  - `reports.scope.sheets.columns.format` (string)
    The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). Only returned if the include query string parameter contains format and this column has a non-default format applied to it.

  - `reports.scope.sheets.columns.formula` (string)
    The formula for the column, if set.

  - `reports.scope.sheets.columns.hidden` (boolean)
    Indicates whether the column is hidden.

  - `reports.scope.sheets.columns.id` (number)
    Column ID.

  - `reports.scope.sheets.columns.index` (number)
    Column index or position. This number is zero-based.

  - `reports.scope.sheets.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.

  - `reports.scope.sheets.columns.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.

  - `reports.scope.sheets.columns.options` (array)
    Array of the options available for the column.

  - `reports.scope.sheets.columns.primary` (boolean)
    Returned only if the column is the Primary Column (value = true).

  - `reports.scope.sheets.columns.symbol` (string)
    When applicable for CHECKBOX or PICKLIST column types. See [Symbol Columns](/api/smartsheet/openapi/columns).

  - `reports.scope.sheets.columns.systemColumnType` (string)
    See [System Columns](/api/smartsheet/openapi/columns).
    Enum: "AUTO_NUMBER", "CREATED_BY", "CREATED_DATE", "MODIFIED_BY", "MODIFIED_DATE"

  - `reports.scope.sheets.columns.tags` (array)
    Set of tags to indicate special columns. Each element in the array is set to one of the listed enum values.
    Enum: "CALENDAR_END_DATE", "CALENDAR_START_DATE", "CARD_DONE", "GANTT_ALLOCATION", "GANTT_ASSIGNED_RESOURCE", "GANTT_DISPLAY_LABEL", "GANTT_DURATION", "GANTT_END_DATE", "GANTT_PERCENT_COMPLETE", "GANTT_PREDECESSOR", "GANTT_START_DATE", "BASELINE_START_DATE", "BASELINE_END_DATE", "BASELINE_VARIANCE"

  - `reports.scope.sheets.columns.title` (string)
    Column title.

  - `reports.scope.sheets.columns.type` (string)
    See [Column Types](/api/smartsheet/openapi/columns)
    Enum: "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER"

  - `reports.scope.sheets.columns.validation` (boolean)
    Indicates whether validation has been enabled for the column (value = true).

  - `reports.scope.sheets.columns.version` (number)
    * 0: CONTACT_LIST, PICKLIST, or TEXT_NUMBER.
* 1: MULTI_CONTACT_LIST.
* 2: MULTI_PICKLIST.
    Enum: 0, 1, 2

  - `reports.scope.sheets.columns.width` (number)
    Display width of the column in pixels.

  - `reports.scope.sheets.crossSheetReferences` (array)
    Array of CrossSheetReference objects.
Only returned if the [include](/api/smartsheet/openapi/sheets/getsheet) query string parameter contains crossSheetReferences.

  - `reports.scope.sheets.crossSheetReferences.endColumnId` (number)
    Defines ending edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.

  - `reports.scope.sheets.crossSheetReferences.endRowId` (number)
    Defines ending edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.

  - `reports.scope.sheets.crossSheetReferences.id` (number)
    Cross-sheet reference ID, guaranteed unique within referencing sheet.

  - `reports.scope.sheets.crossSheetReferences.name` (string)
    Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References.

  - `reports.scope.sheets.crossSheetReferences.startColumnId` (number)
    Defines beginning edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.

  - `reports.scope.sheets.crossSheetReferences.startRowId` (number)
    Defines beginning edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.

  - `reports.scope.sheets.crossSheetReferences.status` (string)
    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.
    Enum: "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INVALID/UNKNOWN", "NOT-SHARED", "OK"

  - `reports.scope.sheets.crossSheetReferences.sourceSheetId` (number)
    Sheet ID of source sheet.

  - `reports.scope.sheets.dependenciesEnabled` (boolean)
    Indicates whether dependencies are enabled.

  - `reports.scope.sheets.discussions` (array)
    Array of Discussion objects
Only returned if the [include](/api/smartsheet/openapi/sheets/getsheet) query string parameter contains discussions.

  - `reports.scope.sheets.discussions.id` (number)
    Discussion ID.

  - `reports.scope.sheets.discussions.comments` (array)
    Array of comments in discussion. Only returned if the include query string parameter contains comments.

  - `reports.scope.sheets.discussions.comments.attachments` (array)
    Array of attachments on comments.

  - `reports.scope.sheets.discussions.comments.createdBy` (object)
    User object containing name and email of the creator of this comment.

  - `reports.scope.sheets.discussions.comments.discussionId` (number)
    Discussion ID of discussion that contains comment.

  - `reports.scope.sheets.discussions.comments.id` (number)
    Comment ID.

  - `reports.scope.sheets.discussions.comments.text` (string)
    Comment body.

  - `reports.scope.sheets.discussions.commentAttachments` (array)
    Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments.

  - `reports.scope.sheets.discussions.commentCount` (number)
    Number of comments in the discussion.

  - `reports.scope.sheets.discussions.createdBy` (object)
    User object containing name and email of the user who created the discussion.

  - `reports.scope.sheets.discussions.lastCommentedAt` (any)

  - `reports.scope.sheets.discussions.lastCommentedUser` (object)
    User object containing name and email of the user who last commented on the discussion.

  - `reports.scope.sheets.discussions.parentId` (number)
    The ID of the associated row or sheet.

  - `reports.scope.sheets.discussions.parentType` (string)
    Type of parent object.
    Enum: "ROW", "SHEET"

  - `reports.scope.sheets.discussions.readOnly` (boolean)
    Indicates whether the user can modify the discussion.

  - `reports.scope.sheets.discussions.title` (string)
    Title automatically created by duplicating the first 100 characters of top-level comment.

  - `reports.scope.sheets.effectiveAttachmentOptions` (array)
    Array of enum strings (see [Attachment.attachmentType](/api/smartsheet/openapi/attachments) indicating the allowable attachment options for the current user and sheet.

  - `reports.scope.sheets.ganttEnabled` (boolean)
    Indicates whether "Gantt View" is enabled.

  - `reports.scope.sheets.hasSummaryFields` (boolean)
    Indicates whether a sheet summary is present.

  - `reports.scope.sheets.isMultiPicklistEnabled` (boolean)
    Indicates whether multi-select is enabled.

  - `reports.scope.sheets.name` (string)
    Sheet name.

  - `reports.scope.sheets.owner` (string)
    Email address of the sheet owner.

  - `reports.scope.sheets.permalink` (string)
    URL that represents a direct link to the sheet in Smartsheet.

  - `reports.scope.sheets.projectSettings` (object)
    Represents the project settings dependencies for a specific sheet. Project settings may be updated on sheets that the user has editor access.

  - `reports.scope.sheets.projectSettings.lengthOfDay` (number)
    Length of a workday for a project sheet.

  - `reports.scope.sheets.projectSettings.nonWorkingDays` (array)
    Non-working days for a project sheet.

  - `reports.scope.sheets.projectSettings.workingDays` (array)
    Enum: "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"

  - `reports.scope.sheets.readOnly` (boolean)
    Returned only if the sheet belongs to an expired trial (value = true).

  - `reports.scope.sheets.resourceManagementEnabled` (boolean)
    Indicates that resource management is enabled.

  - `reports.scope.sheets.resourceManagementType` (string)
    Resource Management type. Indicates the type of RM that is enabled.
    Enum: "NONE", "LEGACY_RESOURCE_MANAGEMENT", "RESOURCE_MANAGEMENT_BY_SMARTSHEET"

  - `reports.scope.sheets.rows` (array)

  - `reports.scope.sheets.rows.id` (number)
    Row ID.

  - `reports.scope.sheets.rows.sheetId` (number)
    Parent sheet ID.

  - `reports.scope.sheets.rows.siblingId` (number)
    Sibling ID.

  - `reports.scope.sheets.rows.attachments` (array)
    Attachments on row. Only returned if the include query string parameter contains attachments.

  - `reports.scope.sheets.rows.cells` (array)
    Cells belonging to the row.

  - `reports.scope.sheets.rows.cells.columnId` (number)
    The ID of the column that the cell is located in.

  - `reports.scope.sheets.rows.cells.rowId` (number)
    The ID of the row the cell is located in.

  - `reports.scope.sheets.rows.cells.columnType` (string)
    Only returned if the include query string parameter contains columnType.

  - `reports.scope.sheets.rows.cells.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.

  - `reports.scope.sheets.rows.cells.displayValue` (string)
    Visual representation of cell contents, as presented to the user in the UI.

  - `reports.scope.sheets.rows.cells.format` (string)
    The format descriptor. Only returned if the include query string parameter contains format and this cell has a non-default format applied.

  - `reports.scope.sheets.rows.cells.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".

  - `reports.scope.sheets.rows.cells.hyperlink` (object)

  - `reports.scope.sheets.rows.cells.hyperlink.reportId` (number)
    If non-null, this hyperlink is a link to the report with this ID.

  - `reports.scope.sheets.rows.cells.hyperlink.sheetId` (number)
    If non-null, this hyperlink is a link to the sheet with this ID.

  - `reports.scope.sheets.rows.cells.hyperlink.sightId` (number)
    If non-null, this hyperlink is a link to the dashboard with this ID.

  - `reports.scope.sheets.rows.cells.hyperlink.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.

  - `reports.scope.sheets.rows.cells.image` (object)

  - `reports.scope.sheets.rows.cells.image.altText` (string)
    Alternate text for the image.

  - `reports.scope.sheets.rows.cells.image.height` (number)
    Original height (in pixels) of the uploaded image.

  - `reports.scope.sheets.rows.cells.image.id` (string)
    Image ID.

  - `reports.scope.sheets.rows.cells.image.width` (number)
    Original width (in pixels) of the uploaded image.

  - `reports.scope.sheets.rows.cells.linkInFromCell` (object)

  - `reports.scope.sheets.rows.cells.linkInFromCell.columnId` (number)
    Column ID of the linked cell.

  - `reports.scope.sheets.rows.cells.linkInFromCell.rowId` (number)
    Row ID of the linked cell.

  - `reports.scope.sheets.rows.cells.linkInFromCell.sheetId` (number)
    Sheet ID of the sheet that the linked cell belongs to.

  - `reports.scope.sheets.rows.cells.linkInFromCell.sheetName` (string)
    Sheet name of the linked cell.

  - `reports.scope.sheets.rows.cells.linkInFromCell.status` (string)
    * BLOCKED One of several other values indicating unusual error conditions.
* BROKEN The row or sheet linked to was deleted.
* CIRCULAR One of several other values indicating unusual error conditions.
* DISABLED One of several other values indicating unusual error conditions.
* INACCESSIBLE The sheet linked to cannot be viewed by this user.
* INVALID One of several other values indicating unusual error conditions.
* NOT_SHARED One of several other values indicating unusual error conditions.
* OK The link is in a good state.
    Enum: "BLOCKED", "BROKEN", "CIRCULAR", "DISABLED", "INACCESSIBLE", "INVALID", "NOT_SHARED", "OK"

  - `reports.scope.sheets.rows.cells.linksOutToCells` (array)

  - `reports.scope.sheets.rows.cells.objectValue` (any)

  - `reports.scope.sheets.rows.cells.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.

  - `reports.scope.sheets.rows.cells.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.

  - `reports.scope.sheets.rows.cells.value` (any)
    A string, number, or a Boolean value -- depending on the cell type and the data in the cell. Cell values larger than 4000 characters are silently truncated. An empty cell returns no value.

  - `reports.scope.sheets.rows.columns` (array)
    Columns of row. Only returned if the include query string parameter contains columns.

  - `reports.scope.sheets.rows.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.
    Example: ",,1,1,,,,,,,,,,,,,"

  - `reports.scope.sheets.rows.createdBy` (object)
    User object containing name and email of the creator of this row.

  - `reports.scope.sheets.rows.discussions` (array)
    Discussions on the row. Only returned if the include query string parameter contains discussions.

  - `reports.scope.sheets.rows.proof` (object)
    Object containing zero or more media items, including images, videos, and documents, for review, editing, or approval.

  - `reports.scope.sheets.rows.proof.id` (number)
    Proof ID of the proof version.

  - `reports.scope.sheets.rows.proof.originalId` (number)
    Proof ID of the original proof version.

  - `reports.scope.sheets.rows.proof.name` (string)
    Proof name. This is the same as primary column value. If the primary column value is empty, name is empty.

  - `reports.scope.sheets.rows.proof.type` (string)
    File type for the proof version.
    Enum: "DOCUMENT", "IMAGE", "MIXED", "NONE", "VIDEO"

  - `reports.scope.sheets.rows.proof.documentType` (string)
    If type=DOCUMENT, then this indicates the type of file, such as PDF.

  - `reports.scope.sheets.rows.proof.proofRequestUrl` (string)
    URL to review a proofing request.

  - `reports.scope.sheets.rows.proof.version` (number)
    The version number of the proof.

  - `reports.scope.sheets.rows.proof.lastUpdatedAt` (any)

  - `reports.scope.sheets.rows.proof.lastUpdatedBy` (object)
    User object containing name and email of the user who last updated the proof.

  - `reports.scope.sheets.rows.proof.isCompleted` (boolean)
    Indicates whether the proof is completed.

  - `reports.scope.sheets.rows.proof.attachments` (array)
    Array of Attachment objects. Only returned if the include query string parameter contains attachments.

  - `reports.scope.sheets.rows.proof.discussions` (array)
    Array of Discussion objects. Only returned if the include query string parameter contains discussions.

  - `reports.scope.sheets.rows.expanded` (boolean)
    Indicates whether the row is expanded or collapsed.

  - `reports.scope.sheets.rows.filteredOut` (boolean)
    Indicates if the row is filtered out by a column filter. Only returned if the include query string parameter contains filters.

  - `reports.scope.sheets.rows.format` (string)
    Format descriptor. Only returned if the include query string parameter contains format and this row has a non-default format applied.
    Example: ",,1,1,,,,,,,,,,,,,"

  - `reports.scope.sheets.rows.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.

  - `reports.scope.sheets.rows.locked` (boolean)
    Indicates whether the row is locked.

  - `reports.scope.sheets.rows.lockedForUser` (boolean)
    Indicates whether the row is locked for the requesting user.

  - `reports.scope.sheets.rows.modifiedBy` (object)
    User object containing name and email of the last person to modify this row.

  - `reports.scope.sheets.rows.permaLink` (string)
    URL that represents a direct link to the row in Smartsheet. Only returned if the include query string parameter contains rowPermalink.

  - `reports.scope.sheets.rows.rowNumber` (number)
    Row number within the sheet.

  - `reports.scope.sheets.rows.version` (number)
    Sheet version number that is incremented every time a sheet is modified.

  - `reports.scope.sheets.showParentRowsForFilters` (boolean)
    Returned only if there are column filters on the sheet. Value = true if "show parent rows" is enabled for the filters.

  - `reports.scope.sheets.source` (object)

  - `reports.scope.sheets.source.id` (number)
    The ID of the dashboard, report, sheet, or template from which the enclosing dashboard, report, sheet, or template was created.

  - `reports.scope.sheets.source.type` (string)
    report, sheet, sight (aka dashboard), or template.

  - `reports.scope.sheets.summary` (object)
    Represents the entire summary, or a list of defined fields and values, for a specific sheet.

  - `reports.scope.sheets.summary.fields` (array)
    Array of summary (or metadata) fields defined on the sheet.

  - `reports.scope.sheets.summary.fields.id` (number)
    SummaryField ID.

  - `reports.scope.sheets.summary.fields.createdBy` (object)
    User object containing name and email of the creator of this summary field.

  - `reports.scope.sheets.summary.fields.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.

  - `reports.scope.sheets.summary.fields.formula` (string)
    The formula for a cell, if set.

  - `reports.scope.sheets.summary.fields.index` (number)
    Field index or position. This number is zero-based.

  - `reports.scope.sheets.summary.fields.locked` (boolean)
    Indicates whether the field is locked.

  - `reports.scope.sheets.summary.fields.lockedForUser` (boolean)
    Indicates whether the field is locked for the requesting user.

  - `reports.scope.sheets.summary.fields.modifiedBy` (object)
    User object containing name and email of the user who most recently modified this summary field.

  - `reports.scope.sheets.summary.fields.options` (array)
    When applicable for PICKLIST column type. Array of the options available for the field.

  - `reports.scope.sheets.summary.fields.symbol` (string)
    When applicable for PICKLIST column type.

  - `reports.scope.sheets.summary.fields.title` (string)
    Arbitrary name, must be unique within summary.

  - `reports.scope.sheets.summary.fields.type` (string)
    Enum: "ABSTRACT_DATETIME", "CHECKBOX", "CONTACT_LIST", "DATE", "DATETIME", "DURATION", "MULTI_CONTACT_LIST", "MULTI_PICKLIST", "PICKLIST", "PREDECESSOR", "TEXT_NUMBER"

  - `reports.scope.sheets.summary.fields.validation` (boolean)
    Indicates whether summary field values are restricted to the type.

  - `reports.scope.sheets.totalRowCount` (number)
    The total number of rows in the sheet.

  - `reports.scope.sheets.userPermissions` (object)
    Describes the current user's editing permissions for a specific sheet.

  - `reports.scope.sheets.userPermissions.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"

  - `reports.scope.sheets.userSettings` (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).

  - `reports.scope.sheets.userSettings.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.

  - `reports.scope.sheets.userSettings.displaySummaryTasks` (boolean)
    Does this user have "Display Summary Tasks" turned on for this sheet? Applies only to sheets where "Calendar View" has been configured.

  - `reports.scope.sheets.version` (number)
    A number that is incremented every time a sheet is modified.

  - `reports.scope.sheets.workspace` (object)

  - `reports.scope.sheets.workspace.id` (number)
    Workspace ID.

  - `reports.scope.sheets.workspace.name` (string)
    Workspace name.

  - `reports.scope.sheets.workspace.permalink` (string)
    URL that represents a direct link to the workspace in Smartsheet.

  - `reports.scope.sheets.favorite` (boolean)
    Deprecated Returned only if the user has marked this sheet as a favorite in their Home tab (value = true).

  - `reports.scope.workspaces` (array)
    Array of Workspace objects (containing just the workspace ID) that the requester has access to that make up the report.

  - `reports.sourceSheets` (array)
    An array of Sheet objects (without rows), representing the sheets that rows in the report originated from. Only included in the Get Report response if the include parameter specifies sourceSheets.

  - `reports.isSummaryReport` (boolean)
    A boolean to represent whether the report is a sheet summary report or not. If this property is false, it is a row report.

  - `sheets` (array)

  - `sights` (array)

  - `sights.backgroundColor` (string)
    The hex color, for instance #E6F5FE.

  - `sights.defaultWidgetBackgroundColor` (string)
    The hex color of the background color for all widgets except for title widgets on the dashboard, for instance #E6F5FEF4 or #E6F5FE.

  - `sights.columnCount` (number)
    Number of columns that the dashboard contains.

  - `sights.widgets` (array)

  - `sights.widgets.id` (number)
    Widget ID.

  - `sights.widgets.type` (string)
    Type of widget.
    Enum: "CHART", "GRIDGANTT", "IMAGE", "METRIC", "RICHTEXT", "SHEETSUMMARY", "SHORTCUT", "SHORTCUTICON", "SHORTCUTLIST", "TITLE", "WEBCONTENT"

  - `sights.widgets.contents` (any)
    The type of widget content depends on the value of widget.type.

  - `sights.widgets.height` (number)
    Number of rows that the widget occupies on the dashboard.

  - `sights.widgets.showTitle` (boolean)
    True indicates that the client should display the widget title. This is independent of the title string which may be null or empty.

  - `sights.widgets.showTitleIcon` (boolean)
    True indicates that the client should display the sheet icon in the widget title.

  - `sights.widgets.title` (string)
    Title of the widget.

  - `sights.widgets.titleFormat` (string)
    Title format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)).
    Example: ",,1,,,,,,,3,,,,,,1,"

  - `sights.widgets.titleFont` (string)
    List of supported fonts in Dashboards
    Enum: "Arial", "Courier", "Georgia", "Gill Sans", "Helvetica", "Luminari", "Monaco", "Tahoma", "Times New Roman", "Verdana"

  - `sights.widgets.version` (number)
    Widget version number.

  - `sights.widgets.viewMode` (number)
    Indicates the content layout. Must use a query parameter of level=2 to see this information.

  * 1 - centered
  * 2 - left aligned
    Enum: 1, 2

  - `sights.widgets.width` (number)
    Number of columns that the widget occupies on the dashboard.

  - `sights.widgets.xPosition` (number)
    X-coordinate of widget's position on the dashboard.

  - `sights.widgets.yPosition` (number)
    Y-coordinate of widget's position on the dashboard.

  - `sights.workspace` (object)
    A reference to the dashboard's workspace, if the dashboard is in a workspace; otherwise an empty value.
    Example: {"id":1234567890,"name":"Some Workspace"}

  - `sights.id` (number)
    Dashboard ID.

  - `sights.permalink` (string)
    URL that represents a direct link to the dashboard in Smartsheet.

  - `sights.name` (string)
    Dashboard name.

  - `templates` (array)

  - `templates.id` (number)
    Template ID.

  - `templates.type` (string)
    Type of template. Only applicable to public templates.
    Enum: "report", "sheet"

  - `templates.blank` (boolean)
    Indicates whether the template is blank. Only applicable to public templates.

  - `templates.categories` (array)
    Indicates whether the template is blank. Only applicable to public templates.

  - `templates.description` (string)
    Template description.

  - `templates.globalTemplate` (string)
    Type of global template. Only applicable to blank public templates.
    Enum: "BLANK_SHEET", "PROJECT_SHEET", "TASK_LIST"

  - `templates.image` (string)
    URL to the small preview image for this template. Only applicable to non-blank public templates.

  - `templates.largeImage` (string)
    URL to the large preview image for this template. Only applicable to non-blank public templates.

  - `templates.locale` (string)
    Locale of the template. Only applicable to public templates.
    Enum: "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"

  - `templates.name` (string)
    Type of global template.
    Example: "Awesome Project Template"

  - `templates.tags` (array)
    List of search tags for this template. Only applicable to non-blank public templates.

## Response default fields (application/json):

  - `refId` (string)
    The ID of the specific error occurrence. Please include this information when contacting Smartsheet support.

  - `errorCode` (number)
    Custom error code from Smartsheet. See the complete [Error Code List](/api/smartsheet/error-codes).

  - `message` (string)
    Descriptive error message.