GET /sheets/{sheetId}

applies to PDF format only

Possible values:

• "A1"
• "A0"
• "ARCHD"
• "LEGAL"
• "LETTER"
• "WIDE"
• "A4"
• "A3"
• "A2"

Default value: "LETTER"

A comma-separated list of row numbers on which to filter the rows included in the result. Non-existent row numbers are ignored.

A comma-separated list of column ids. The response contains only the specified columns in the "columns" array, and individual rows' "cells" array only contains cells in the specified columns.

A comma-separated list of optional elements to include in the response:

• attachments - includes the metadata for sheet-level and row-level attachments. To include discussion attachments, both attachments and discussions must be present in the include list.
• columnType -includes columnType attribute in the row's cells indicating the type of the column the cell resides in.
• crossSheetReferences - includes the cross-sheet references
• discussions - includes sheet-level and row-level discussions. To include discussion attachments, both attachments and discussions must be present in the include list.
• filters - includes filteredOut attribute indicating if the row should be displayed or hidden according to the sheet's filters.
• filterDefinitions - includes type of filter, operators used, and criteria
• format - includes column, row, cell, and summary fields formatting.
• ganttConfig - includes Gantt chart details.
• objectValue - when used in combination with a level query parameter, includes the email addresses for multi-contact data.
• ownerInfo - includes the owner's email address and the owner's user Id.
• rowPermalink - includes permalink attribute that represents a direct link to the row in the Smartsheet application.
• source - adds the Source object indicating which report, sheet Sight (aka dashboard), or template the sheet was created from, if any.
• writerInfo - includes createdBy and modifiedBy attributes on the row or summary fields, indicating the row or summary field's creator, and last modifier.

Possible values:

• "source"
• "rowPermalink"
• "filterDefinitions"
• "ganttConfig"
• "discussions"
• "objectValue"
• "columnType"
• "format"
• "filters"
• "writerInfo"
• "attachments"
• "crossSheetReferences"
• "ownerInfo"

If version specified is still the current sheet version, then returns an abbreviated Sheet object with only the sheet version property. Otherwise, if the sheet has been modified, returns the complete Sheet object. Intended to allow clients with a cached copy to make sure they have the latest version.

Specifies whether new functionality, such as multi-contact data is returned in a backwards-compatible, text format (level=0, default), multi-contact data (level=1), or multi-picklist data (level=2).

Default value: 1

A comma-separated list of row Ids on which to filter the rows included in the result.

Filter to return only rows that have been modified since the date/time provided. Date should be in ISO-8601 format.

Overrides the existing include={filters} parameter if both are supplied. Applies the given filter (if accessible by the calling user) and marks the affected rows as "filteredOut": true.

A comma-separated list of optional elements to not include in the response:

• filteredOutRows - excludes filtered out rows from response payload if a sheet filter is applied; includes total number of filtered rows
• linkInFromCellDetails - excludes the following attributes from the cell.linkInFromCell object: columnId, rowId, status
• linksOutToCellsDetails - excludes the following attributes from the cell.linksOutToCells array elements: columnId, rowId, status
• nonexistentCells - excludes cells that have never contained any data

Possible values:

• "linkInFromCellDetails"
• "nonexistentCells"
• "filteredOutRows"
• "linksOutToCellsDetails"