--- title: "Get report" method: GET path: "/reports/{reportId}" tags: ["reports"] --- # Get report `GET /reports/{reportId}` Gets a report based on the specified ID ## Query parameters - `include` 'attachments' | 'discussions' | 'proofs' | 'format' | 'objectValue' | 'scope' | 'source' | 'sourceSheets' - `exclude` 'linkInFromCellDetails' | 'linksOutToCellsDetails' - `pageSize` number - `page` number - `level` integer ## Response `200` The Report that was loaded. - Report - `id` number — The report's unique identifier. - `name` string — The report's name. - `totalRowCount` integer — The number of rows in the report. - `accessLevel` 'ADMIN' | 'COMMENTER' | 'EDITOR' | 'EDITOR_SHARE' | 'OWNER' | 'VIEWER' - `effectiveAttachmentOptions` string[] — 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. - `id` number — Workspace ID. - `name` string — Workspace name. - `permalink` string — URL that represents a direct link to this item in Smartsheet. - `createdAt` union - string, date-time - number - `modifiedAt` union - string, date-time - number - `columns` ReportColumn[] - union - object - `title` string, required — Title of a column to match. **Note:** If you specified `primary=true` to match primary columns, you can set the resulting report column title to this value. - `type` 'CHECKBOX' | 'DATE' | 'DATETIME' | 'DURATION' | 'CONTACT_LIST' | 'MULTI_CONTACT_LIST' | 'PICKLIST' | 'MULTI_PICKLIST' | 'PREDECESSOR' | 'TEXT_NUMBER', required — Type of column to match. See [Column Types](/api/smartsheet/openapi/columns). - `systemColumnType` 'CREATED_BY' | 'CREATED_DATE' | 'MODIFIED_BY' | 'MODIFIED_DATE' | 'AUTO_NUMBER' — System column type to match. See [System Columns](/api/smartsheet/openapi/columns). - `sheetNameColumn` boolean — Set this to `true` to match the special "Sheet Name" report column. - `primary` boolean — Set this to `true` to match the primary column. - `virtualId` integer — The virtual ID of this report column. - `index` integer, required — Column index or position. This number is zero-based. Indicates the position of the column in the generated report. - `hidden` boolean — Indicates whether the column is hidden. - `version` 0 | 1 | 2 — * `0`: CONTACT_LIST, PICKLIST, or TEXT_NUMBER. * `1`: MULTI_CONTACT_LIST. * `2`: MULTI_PICKLIST. - `width` integer — Display width of the column in pixels. - `validation` boolean — Indicates whether validation has been enabled for the column (value = **true**). - `autoNumberFormat` object — Specifies how to format values for an auto-generated numbers column. - `fill` string — Indicates zero-padding. It must be between 0 and 10 "0" (zero) characters. - `prefix` string — The prefix. Can include these date tokens: * {DD} * {MM} * {YY} * {YYYY} - `startingNumber` number — The starting number for the auto-ID. - `suffix` string — The suffix. Can include these date tokens: * {DD} * {MM} * {YY} * {YYYY} - object - `title` string, required — Title of a column to match. **Note:** If you specified `primary=true` to match primary columns, you can set the resulting report column title to this value. - `type` 'CHECKBOX' | 'DATE' | 'DATETIME' | 'DURATION' | 'CONTACT_LIST' | 'MULTI_CONTACT_LIST' | 'PICKLIST' | 'MULTI_PICKLIST' | 'PREDECESSOR' | 'TEXT_NUMBER', required — Type of column to match. See [Column Types](/api/smartsheet/openapi/columns). - `systemColumnType` 'CREATED_BY' | 'CREATED_DATE' | 'MODIFIED_BY' | 'MODIFIED_DATE' | 'AUTO_NUMBER', required — System column type to match. See [System Columns](/api/smartsheet/openapi/columns). - `sheetNameColumn` boolean — Set this to `true` to match the special "Sheet Name" report column. - `primary` boolean — Set this to `true` to match the primary column. - `virtualId` integer — The virtual ID of this report column. - `index` integer, required — Column index or position. This number is zero-based. Indicates the position of the column in the generated report. - `hidden` boolean — Indicates whether the column is hidden. - `version` 0 | 1 | 2 — * `0`: CONTACT_LIST, PICKLIST, or TEXT_NUMBER. * `1`: MULTI_CONTACT_LIST. * `2`: MULTI_PICKLIST. - `width` integer — Display width of the column in pixels. - `validation` boolean — Indicates whether validation has been enabled for the column (value = **true**). - `autoNumberFormat` object — Specifies how to format values for an auto-generated numbers column. - `fill` string — Indicates zero-padding. It must be between 0 and 10 "0" (zero) characters. - `prefix` string — The prefix. Can include these date tokens: * {DD} * {MM} * {YY} * {YYYY} - `startingNumber` number — The starting number for the auto-ID. - `suffix` string — The suffix. Can include these date tokens: * {DD} * {MM} * {YY} * {YYYY} - object - `title` string, required — Title of a column to match. **Note:** If you specified `primary=true` to match primary columns, you can set the resulting report column title to this value. - `type` 'CHECKBOX' | 'DATE' | 'DATETIME' | 'DURATION' | 'CONTACT_LIST' | 'MULTI_CONTACT_LIST' | 'PICKLIST' | 'MULTI_PICKLIST' | 'PREDECESSOR' | 'TEXT_NUMBER', required — Type of column to match. See [Column Types](/api/smartsheet/openapi/columns). - `systemColumnType` 'CREATED_BY' | 'CREATED_DATE' | 'MODIFIED_BY' | 'MODIFIED_DATE' | 'AUTO_NUMBER' — System column type to match. See [System Columns](/api/smartsheet/openapi/columns). - `sheetNameColumn` boolean — Set this to `true` to match the special "Sheet Name" report column. - `primary` boolean, required — Set this to `true` to match the primary column. - `virtualId` integer — The virtual ID of this report column. - `index` integer, required — Column index or position. This number is zero-based. Indicates the position of the column in the generated report. - `hidden` boolean — Indicates whether the column is hidden. - `version` 0 | 1 | 2 — * `0`: CONTACT_LIST, PICKLIST, or TEXT_NUMBER. * `1`: MULTI_CONTACT_LIST. * `2`: MULTI_PICKLIST. - `width` integer — Display width of the column in pixels. - `validation` boolean — Indicates whether validation has been enabled for the column (value = **true**). - `autoNumberFormat` object — Specifies how to format values for an auto-generated numbers column. - `fill` string — Indicates zero-padding. It must be between 0 and 10 "0" (zero) characters. - `prefix` string — The prefix. Can include these date tokens: * {DD} * {MM} * {YY} * {YYYY} - `startingNumber` number — The starting number for the auto-ID. - `suffix` string — The suffix. Can include these date tokens: * {DD} * {MM} * {YY} * {YYYY} - object - `title` string, required — Title of a column to match. **Note:** If you specified `primary=true` to match primary columns, you can set the resulting report column title to this value. - `type` 'CHECKBOX' | 'DATE' | 'DATETIME' | 'DURATION' | 'CONTACT_LIST' | 'MULTI_CONTACT_LIST' | 'PICKLIST' | 'MULTI_PICKLIST' | 'PREDECESSOR' | 'TEXT_NUMBER', required — Type of column to match. See [Column Types](/api/smartsheet/openapi/columns). - `systemColumnType` 'CREATED_BY' | 'CREATED_DATE' | 'MODIFIED_BY' | 'MODIFIED_DATE' | 'AUTO_NUMBER' — System column type to match. See [System Columns](/api/smartsheet/openapi/columns). - `sheetNameColumn` boolean, required — Set this to `true` to match the special "Sheet Name" report column. - `primary` boolean — Set this to `true` to match the primary column. - `virtualId` integer — The virtual ID of this report column. - `index` integer, required — Column index or position. This number is zero-based. Indicates the position of the column in the generated report. - `hidden` boolean — Indicates whether the column is hidden. - `version` 0 | 1 | 2 — * `0`: CONTACT_LIST, PICKLIST, or TEXT_NUMBER. * `1`: MULTI_CONTACT_LIST. * `2`: MULTI_PICKLIST. - `width` integer — Display width of the column in pixels. - `validation` boolean — Indicates whether validation has been enabled for the column (value = **true**). - `autoNumberFormat` object — Specifies how to format values for an auto-generated numbers column. - `fill` string — Indicates zero-padding. It must be between 0 and 10 "0" (zero) characters. - `prefix` string — The prefix. Can include these date tokens: * {DD} * {MM} * {YY} * {YYYY} - `startingNumber` number — The starting number for the auto-ID. - `suffix` string — The suffix. Can include these date tokens: * {DD} * {MM} * {YY} * {YYYY} - `rows` ReportRow[] - `id` number — Row ID. - `sheetId` number — The ID of the sheet from which the row originates. - `rowNumber` integer — Row number within the report. - `siblingId` number — Sibling ID. - `locked` boolean — Indicates whether the row is locked. - `lockedForUser` boolean — Indicates whether the row is locked for the requesting user. - `expanded` boolean — Indicates whether the row is expanded or collapsed. - `accessLevel` 'ADMIN' | 'COMMENTER' | 'EDITOR' | 'EDITOR_SHARE' | 'OWNER' | 'VIEWER' - `createdAt` union - string, date-time - number - `modifiedAt` union - string, date-time - number - `dataModifiedAt` union - string, date-time - number - `cells` ReportCell[] — Cells belonging to the row. - `columnId` number — The ID of the column that the cell is located in. - `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. - `value` union — 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. - string - number - boolean - `displayValue` string — Visual representation of cell contents, as presented to the user in the UI. - `proof` Proof — Object containing zero or more media items, including images, videos, and documents, for review, editing, or approval. - `id` number — Proof ID of the proof version. - `originalId` number — Proof ID of the original proof version. - `name` string — Proof name. This is the same as primary column value. If the primary column value is empty, name is empty. - `type` 'DOCUMENT' | 'IMAGE' | 'MIXED' | 'NONE' | 'VIDEO' — File type for the proof version. - `documentType` string — If `type=DOCUMENT`, then this indicates the type of file, such as PDF. - `proofRequestUrl` string — URL to review a proofing request. - `version` number — The version number of the proof. - `lastUpdatedAt` union - string, date-time - number - `lastUpdatedBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `isCompleted` boolean — Indicates whether the proof is completed. - `attachments` Attachment[] — Array of Attachment objects. Only returned if the include query string parameter contains attachments. - `id` number — Attachment ID. - `parentId` number — The ID of the parent. - `attachmentType` 'BOX_COM' | 'DROPBOX' | 'EGNYTE' | 'EVERNOTE' | 'FILE' | 'GOOGLE_DRIVE' | 'LINK' | 'ONEDRIVE' | 'TRELLO' — Attachment type. Note--Dropbox, Egnyte, and Evernote are not supported for Smartsheet.gov accounts. - `attachmentSubType` 'DOCUMENT' | 'DRAWING' | 'FOLDER' | 'PDF' | 'PRESENTATION' | 'SPREADSHEET' — Attachment sub type. Note--Folder type is for EGNYTE values and the rest are GOOGLE_DRIVE values. - `mimeType` string — Attachment MIME type. - `parentType` 'COMMENT' | 'PROOF' | 'ROW' | 'SHEET' — The type of object the attachment belongs to. - `createdAt` union - string, date-time - number - `createdBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `name` string — Attachment name. - `sizeInKb` number — The size of the file, if the attachmentType is FILE. - `url` string — Attachment temporary URL (files only). - `urlExpiresInMillis` number — Attachment temporary URL time to live (files only). - `discussions` Discussion[] — Array of Discussion objects. Only returned if the include query string parameter contains discussions. - `accessLevel` 'ADMIN' | 'COMMENTER' | 'EDITOR' | 'EDITOR_SHARE' | 'OWNER' | 'VIEWER' - `id` number — Discussion ID. - `comments` Comment[] — Array of comments in discussion. Only returned if the include query string parameter contains comments. - `attachments` Attachment[] — Array of attachments on comments. - `id` number — Attachment ID. - `parentId` number — The ID of the parent. - `attachmentType` 'BOX_COM' | 'DROPBOX' | 'EGNYTE' | 'EVERNOTE' | 'FILE' | 'GOOGLE_DRIVE' | 'LINK' | 'ONEDRIVE' | 'TRELLO' — Attachment type. Note--Dropbox, Egnyte, and Evernote are not supported for Smartsheet.gov accounts. - `attachmentSubType` 'DOCUMENT' | 'DRAWING' | 'FOLDER' | 'PDF' | 'PRESENTATION' | 'SPREADSHEET' — Attachment sub type. Note--Folder type is for EGNYTE values and the rest are GOOGLE_DRIVE values. - `mimeType` string — Attachment MIME type. - `parentType` 'COMMENT' | 'PROOF' | 'ROW' | 'SHEET' — The type of object the attachment belongs to. - `createdAt` union - … - `createdBy` MiniUser — MiniUser Object - … - `name` string — Attachment name. - `sizeInKb` number — The size of the file, if the attachmentType is FILE. - `url` string — Attachment temporary URL (files only). - `urlExpiresInMillis` number — Attachment temporary URL time to live (files only). - `createdAt` union - string, date-time - number - `createdBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `discussionId` number — Discussion ID of discussion that contains comment. - `id` number — Comment ID. - `modifiedAt` union - string, date-time - number - `text` string — Comment body. - `commentAttachments` Attachment[] — Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments. - `id` number — Attachment ID. - `parentId` number — The ID of the parent. - `attachmentType` 'BOX_COM' | 'DROPBOX' | 'EGNYTE' | 'EVERNOTE' | 'FILE' | 'GOOGLE_DRIVE' | 'LINK' | 'ONEDRIVE' | 'TRELLO' — Attachment type. Note--Dropbox, Egnyte, and Evernote are not supported for Smartsheet.gov accounts. - `attachmentSubType` 'DOCUMENT' | 'DRAWING' | 'FOLDER' | 'PDF' | 'PRESENTATION' | 'SPREADSHEET' — Attachment sub type. Note--Folder type is for EGNYTE values and the rest are GOOGLE_DRIVE values. - `mimeType` string — Attachment MIME type. - `parentType` 'COMMENT' | 'PROOF' | 'ROW' | 'SHEET' — The type of object the attachment belongs to. - `createdAt` union - string, date-time - number - `createdBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `name` string — Attachment name. - `sizeInKb` number — The size of the file, if the attachmentType is FILE. - `url` string — Attachment temporary URL (files only). - `urlExpiresInMillis` number — Attachment temporary URL time to live (files only). - `commentCount` number — Number of comments in the discussion. - `createdBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `lastCommentedAt` union - string, date-time - number - `lastCommentedUser` MiniUser — MiniUser Object - `email` string, email - `name` string - `parentId` number — The ID of the associated row or sheet. - `parentType` 'ROW' | 'SHEET' — Type of parent object. - `readOnly` boolean — Indicates whether the user can modify the discussion. - `title` string — Title automatically created by duplicating the first 100 characters of top-level comment. - `isSummaryReport` boolean — If true, this is a sheet summary report; otherwise, it's a row report. ## Other responses - `default` — Generic Error Payload --- [API](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference.md) · [All operations](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smartsheet/smartsheet-openapi-reference/versions/b4afda95fb51/schema)