# Get report

Gets a report based on the specified ID

Endpoint: GET /reports/{reportId}
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.

## 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
  * discussions
  * proofs
  * format
  * objectValue - when used in combination with a level query parameter, includes the email addresses for multi-contact data
  * scope - adds the report's scope to the response
  * source - adds the Source object indicating which report the report was created from, if any
  * sourceSheets
    Enum: "attachments", "discussions", "proofs", "format", "objectValue", "scope", "source", "sourceSheets"

  - `exclude` (string)
    A comma-separated list of optional elements to not include in the response
    Enum: "linkInFromCellDetails", "linksOutToCellsDetails"

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

  - `level` (integer)
    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=3).

## Path parameters:

  - `reportId` (number, required)
    ID of the report being accessed.

## Response 200 fields (application/json):

  - `id` (number)
    The report's unique identifier.

  - `name` (string)
    The report's name.

  - `totalRowCount` (integer)
    The number of rows in the report.

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

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

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

  - `cellImageUploadEnabled` (boolean)
    If true,images can be uploaded to the report's cells.

  - `workspace` (object)
    The workspace in which the report resides.

  - `workspace.id` (number)
    Workspace ID.

  - `workspace.name` (string)
    Workspace name.

  - `permalink` (string)
    URL that represents a direct link to this item in Smartsheet.

  - `createdAt` (any)

  - `modifiedAt` (any)

  - `columns` (array)

  - `rows` (array)

  - `rows.id` (number)
    Row ID.

  - `rows.sheetId` (number)
    The ID of the sheet from which the row originates.

  - `rows.rowNumber` (integer)
    Row number within the report.

  - `rows.siblingId` (number)
    Sibling ID.

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

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

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

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

  - `rows.createdAt` (any)

  - `rows.modifiedAt` (any)

  - `rows.dataModifiedAt` (any)

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

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

  - `rows.cells.virtualColumnId` (number)
    This property refers to the cell's parent column in the report, while the columnId property refers to the cell's parent column in its originating source sheet.

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

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

  - `isSummaryReport` (boolean)
    If true, this is a sheet summary report; otherwise, it's a row report.

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