Related Items

A row is comprised of a collection of cells, and may optionally contain attachments and discussions.

Row Attachments

For details about working with a row's attachments, see Attachments.

Row Cells

For details about working with a row's cells, see Cells.

For details about working with images in cells, see Cell Images.

Row Discussions

For details about working with a row's discussions, see Discussions.

Row Include Flags

Endpoints which return rows (for example, Get Sheet, Get Row) support the optional include query string parameter. If specified, the value of the include parameter is a comma-delimited list of flags that indicate additional attributes to be included in each Row object within the response.

Include Flag Description
attachments Includes row attachments array.
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.
discussions Includes row discussions array.
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.
format Includes format attribute on the row, its cells, or summary fields. See Formatting.
objectValue Includes objectValue attribute on cells containing values. For more information see Cell Reference.
rowPermalink Includes permalink attribute that represents a direct link to the row in the Smartsheet application.
rowWriterInfo DEPRECATED Includes createdBy and modifiedBy attributes on the row, indicating the row's creator, and last modifier.
writerInfo Includes createdBy and modifiedBy attributes on the row or summary fields, indicating the row or summary field's creator, and last modifier.

Specify Row Location

When you add a row, the default behavior is for Smartsheet to put the new row at the bottom of the sheet. And when you update a row, the default behavior is to keep the row where it is. It is not necessary to use a location-specifier attribute if you want the default behavior.

To specify a location for new or updated rows other than the defaults, use the table below for reference. The table details possible row locations and provides JSON examples to help you construct one or more Row objects with location-specifier attributes.

Note the following restrictions:

  • Use only one location-specifier attribute per request, unless you use parentId and toBottom or siblingId and above.
  • If you specify multiple rows in the request, all rows must have the same location-specifier attributes.
  • If you specify the parentId attribute, you cannot also specify the siblingId attribute.
  • If you specify the siblingId attribute, you cannot also specify the parentId, toTop, or toBottom attributes.
  • If you want to indent or outdent multiple rows, use the parentId attribute.
Destination Row Attributes Examples
Top of a sheet toTop ("toTop": true}
Bottom of a sheet toBottom ("toBottom": true}
Top of an indented section a.k.a., first child row parentId ("parentId": 8896508249565060}
Bottom of an indented section a.k.a., last child row parentId +
toBottom
{"parentId": 8896508249565060, "toBottom": true}
Below a specific row, at the same indent level siblingId {"siblingId": 8896508249565060}
Above a specific row, at the same indent level siblingId +
above
{"siblingId": 8896508249565060, "above": true}
Indent one existing row, must have a value of "1" indent {"indent": 1}
Outdent one existing row, must have a value of "1" outdent {"outdent": 1}
➔ Next to Search Basics