# Get sheet

Gets a sheet in the format specified, based on the sheet Id.

Endpoint: GET /sheets/{sheetId}
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"

  - `Accept` (string)
    The Accept request-header field can be used to specify certain media types which are acceptable for the response.

## Path parameters:

  - `sheetId` (number, required)
    ID of the sheet being accessed.

## Query parameters:

  - `accessApiLevel` (number)
    Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1.

  - `include` (string)
    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.
    Enum: "attachments", "columnType", "crossSheetReferences", "discussions", "filters", "filterDefinitions", "format", "ganttConfig", "objectValue", "ownerInfo", "rowPermalink", "source", "writerInfo"

  - `exclude` (string)
    A comma-separated list of element types to exclude from the response:
  * filteredOutRows - excludes filtered-out rows from response payload if a sheet filter is applied; includes total number of filtered rows
  * linkInFromCellDetails - excludes the following attributes from the cell.linkInFromCell object: columnId, rowId, status
  * linksOutToCellsDetails - excludes the following attributes from the cell.linksOutToCells array elements: columnId, rowId, status
  * nonexistentCells - excludes empty cells
    Enum: "filteredOutRows", "linkInFromCellDetails", "linksOutToCellsDetails", "nonexistentCells"

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

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

  - `ifVersionAfter` (integer)
    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.

  - `level` (integer)
    Specifies whether object data types, such as multi-contact data are returned in a backwards-compatible, text format in text/number columns.  - Set level=0 (default) to use text/number columns for multi-contact data and multi-picklist data.  - Set level=1 to use multiple-entry contact list columns for multi-contact data; multi-picklist data is returned in text/number columns.  - Set level=2 to use multiple-entry contact list columns for multi-contact data and use multiple-entry picklist columns for multi-picklist data.

  - `pageSize` (number)
    The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request.

  - `page` (number)
    Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned.

  - `paperSize` (string)
    applies to PDF format only
    Enum: "LETTER", "LEGAL", "WIDE", "ARCHD", "A4", "A3", "A2", "A1", "A0"

  - `rowIds` (string)
    A comma-separated list of row Ids on which to filter the rows included in the result.

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

  - `rowsModifiedSince` (any)
    Filter to return only rows that have been modified since the date/time provided. Date should be in ISO-8601 format.
    Example: "2020-01-30T13:25:32-07:00"

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