SMsmartsheet
rows

Get row

Changed on

Gets the sheet row specified by the sheet and row IDs.

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

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: READ_SHEETS

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'attachments' | 'columns' | 'columnType' | 'discussions' | 'filters' | 'format' | 'objectValue' | 'proofs' | 'rowPermalink' | 'writerInfo'

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

Include FlagDescription
attachmentsIncludes row attachments array.<br/>To include discussion attachments, both attachments and discussions must be present in the include list.
columnsIncludes the row columns as an array.
columnTypeIncludes columnType attribute in the row's cells indicating the type of the column the cell resides in.
discussionsIncludes row discussions array.<br/>To include discussion attachments, both attachments and discussions must be present in the include list.
filtersIncludes filteredOut attribute indicating if the row should be displayed or hidden according to the sheet's filters.
formatIncludes format attribute on the row, its cells, or summary fields. See Cell formatting.
objectValueIncludes objectValue attribute on cells containing values. For more information see Cell Reference.
proofsIncludes row proof object containing proof information associated with the row. For more information see Proof.
rowPermalinkIncludes permalink attribute that represents a direct link to the row in the Smartsheet application.
writerInfoIncludes createdBy and modifiedBy attributes on the row or summary fields, indicating the row or summary field's creator, and last modifier.
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.

  • Set level=0 (default) to use text/number columns for multi-contact data and multi-picklist data.
  • Set level=1 to use multiple-entry contact list columns for multi-contact data; multi-picklist data is returned in text/number columns.
  • 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 the specified row.

sheetIdnumber

Sheet identifier.

accessLevel'ADMIN' | 'COMMENTER' | 'EDITOR' | 'EDITOR_SHARE' | 'OWNER' | 'VIEWER'

Sheet access level.

versionnumber

Sheet version number; it increments every time a sheet is modified.

idnumber

Row ID.

siblingIdnumber

Identifies the row immediately above this row, if one exists.

If you use this property as the only location specifier in a write operation, this row is placed immediately below the siblingId row. If you include this property and an above property in a write operation, this row is placed immediately above the siblingId row.

Note: In add/update row operations, siblingId can't be used with parentId.

parentIdnumber

Identifies a row that is the hierarchical parent of this row, if one exists.

If you use this property as the only location specifier in a write operation, this row becomes the child row immediately below the parentId row. If you include this property and a toBottom property in a write operation, this row becomes the last child below the parentId row.

Note: In add/update row operations, siblingId can't be used with parentId.

toToptrue

Places the row at the top of the sheet. This property can't be used with a siblingId property.

toBottomtrue

Use this property with a parentId property to make this row the last child below the parentId row.

abovetrue

Use this property with a siblingId to place this row immediately above the siblingId row.

conditionalFormatstring

Describes this row's conditional format. Only returned if the include query string parameter contains format and this row has a conditional format applied.

filteredOutboolean

Indicates if the row is filtered out by a column filter. Only returned if the include query string parameter contains filters.

formatstring

Format descriptor. Only returned if the include query string parameter contains format and this row has a non-default format applied.

Refer to Cell formatting, for format descriptor details.

inCriticalPathboolean

Only returned, with a value of true, if the sheet is a project sheet with dependencies enabled and this row is in the critical path.

lockedboolean

Indicates whether the row is locked.

lockedForUserboolean

Indicates whether the row is locked for the requesting user.

permaLinkstring

URL that represents a direct link to the row in Smartsheet. Only returned if the include query string parameter contains rowPermalink.

rowNumbernumber

Row number within the sheet.

Example response

{
  "attachments": [
    {
      "mimeType": "PNG",
      "createdBy": {
        "email": "jane.doe@smartsheet.com",
        "name": "Jane Doe"
      }
    }
  ],
  "cells": [
    {
      "objectValue": {
        "objectType": "ABSTRACT_DATETIME",
        "value": "2025-03-03T16:59:59"
      }
    }
  ],
  "columns": [
    {
      "id": 4567890123,
      "width": 150,
      "tags": []
    }
  ],
  "conditionalFormat": ",,1,1,,,,,,,,,,,,,",
  "createdBy": {
    "email": "jane.doe@smartsheet.com",
    "name": "Jane Doe"
  },
  "discussions": [
    {
      "comments": [
        {
          "attachments": [
            {
              "mimeType": "PNG",
              "createdBy": {
                "email": "jane.doe@smartsheet.com",
                "name": "Jane Doe"
              }
            }
          ],
          "createdBy": {
            "email": "jane.doe@smartsheet.com",
            "name": "Jane Doe"
          }
        }
      ],
      "commentAttachments": [
        {
          "mimeType": "PNG",
          "createdBy": {
            "email": "jane.doe@smartsheet.com",
            "name": "Jane Doe"
          }
        }
      ],
      "createdBy": {
        "email": "jane.doe@smartsheet.com",
        "name": "Jane Doe"
      },
      "lastCommentedUser": {
        "email": "jane.doe@smartsheet.com",
        "name": "Jane Doe"
      }
    }
  ],
  "proof": {
    "lastUpdatedBy": {
      "email": "jane.doe@smartsheet.com",
      "name": "Jane Doe"
    },
    "attachments": [
      {
        "mimeType": "PNG",
        "createdBy": {
          "email": "jane.doe@smartsheet.com",
          "name": "Jane Doe"
        }
      }
    ],
    "discussions": [
      {
        "comments": [
          {
            "attachments": [
              {
                "mimeType": "PNG",
                "createdBy": {
                  "email": "jane.doe@smartsheet.com",
                  "name": "Jane Doe"
                }
              }
            ],
            "createdBy": {
              "email": "jane.doe@smartsheet.com",
              "name": "Jane Doe"
            }
          }
        ],
        "commentAttachments": [
          {
            "mimeType": "PNG",
            "createdBy": {
              "email": "jane.doe@smartsheet.com",
              "name": "Jane Doe"
            }
          }
        ],
        "createdBy": {
          "email": "jane.doe@smartsheet.com",
          "name": "Jane Doe"
        },
        "lastCommentedUser": {
          "email": "jane.doe@smartsheet.com",
          "name": "Jane Doe"
        }
      }
    ]
  },
  "format": ",,1,1,,,,,,,,,,,,,",
  "modifiedBy": {
    "email": "jane.doe@smartsheet.com",
    "name": "Jane Doe"
  }
}

Changes

  • 5fecdbbecd34Revision changes
    • info

      the response optional property /// became write-only for the status

    • info

      the response optional property /// became write-only for the status

  • 6b9653485729Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new enum value attachments to the query request parameter include

    • info

      added the new enum value columnType to the query request parameter include

    • info

      added the new enum value discussions to the query request parameter include

    • info

      added the new enum value format to the query request parameter include

    • info

      added the new enum value objectValue to the query request parameter include

    • info

      added the new enum value proofs to the query request parameter include

    • info

      added the new enum value rowPermalink to the query request parameter include

    • info

      added the new enum value writerInfo to the query request parameter include

    • info

      added subschema #1 to the response body allOf list for the response status