v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
rows

Get row

Gets the row specified in the URL.

get/sheets/{sheetId}/rows/{rowId}

Query parameters

accessApiLevelnumber

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'columns' | 'filters'

A comma-separated list of elements to include in the response.

See Row Include Flags.

Also supports the columns include flag, which adds a columns array that specifies all of the columns for the sheet. This enables you to have the full context of the cells in the row.

The filters include flag returns a filteredOut attribute indicating if the row should be displayed or hidden according to the sheet's filters.

exclude'filteredOutRows' | 'linkInFromCellDetails' | 'linksOutToCellsDetails' | 'nonexistentCells'

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
levelinteger

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

Response

Returns Row object populated according to the specified parameters.

idnumber

Row ID.

sheetIdnumber

Parent sheet ID.

rowNumbernumber

Row number within the sheet.

expandedboolean

Indicates whether the row is expanded or collapsed.