| Parameter |
Label |
Required |
Options |
Description |
| Id |
Row Id(s) - Comma separated (Blank=All Rows) |
NO |
|
Restrict results to records specified by a comma-separated list of IDs. Max IDs per request controlled by BatchSize property (found in Pagination template)
|
| RowNumber |
Row Number(s) - Comma separated list (Blank=All Rows) |
NO |
|
A comma-separated list of row numbers on which to filter the rows included in the result. Non-existent row numbers are ignored.
|
| SheetId |
SheetId |
YES |
|
|
| RowsModifiedSince |
Rows Modified Since |
NO |
| Option |
Value |
| 2020-01-30T13:25:32 |
2020-01-30T13:25:32 |
| 2020-01-30 |
2020-01-30 |
| now |
now |
| today |
today |
| yesterday |
yesterday |
| monthstart |
monthstart |
| monthend |
monthend |
| yearstart |
yearstart |
| yearend |
yearend |
| weekstart |
weekstart |
| weekend |
weekend |
| yearstart-1y |
yearstart-1y |
| yearend-1y |
yearend-1y |
| monthstart-1d |
monthstart-1d |
| monthend+1d |
monthend+1d |
| today-24h |
today-24h |
| now-24h |
now-24h |
| now-1d |
now-1d |
| today+7d |
today+7d |
|
|
| Exclude |
Exclude |
NO |
| Option |
Value |
| filteredOutRows |
filteredOutRows |
| linkInFromCellDetails |
linkInFromCellDetails |
| linksOutToCellsDetails |
linksOutToCellsDetails |
| nonexistentCells |
nonexistentCells |
|
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
|
| Include |
Include |
NO |
| Option |
Value |
| attachments |
attachments |
| columnType |
columnType |
| crossSheetReferences |
crossSheetReferences |
| discussions |
discussions |
| filters |
filters |
| filterDefinitions |
filterDefinitions |
| format |
format |
| ganttConfig |
ganttConfig |
| objectValue |
objectValue |
| ownerInfo |
ownerInfo |
| rowPermalink |
rowPermalink |
| source |
source |
| writerInfo |
writerInfo |
|
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.
|
| ColumnIds |
Column Ids (Default=All Columns) |
NO |
|
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.
|
