v1

latestOpenAPI 3.0.32026-08-061874701.5 MB

sheetSummary

Get sheet summary

Returns object containing array of summary fields. Allows for pagination of results.

get/sheets/{sheetId}/summary

Query parameters

include'format' | 'writerInfo'

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

format: includes format info for cells, rows, and summary fields
writerInfo: includes createdBy and modifiedBy attributes for rows and summary fields

exclude'displayValue' | 'image' | 'imageAltText'

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

displayValue: excludes displayValue info for cells, rows, and summary fields
image: excludes image attributes for cells and summary fields
imageAltText: excludes alt text for cells and summary fields

Response

Example response

{
  "fields": [
    {
      "createdBy": {
        "email": "jane.doe@smartsheet.com",
        "name": "Jane Doe"
      },
      "modifiedBy": {
        "email": "jane.doe@smartsheet.com",
        "name": "Jane Doe"
      },
      "objectValue": {
        "objectType": "CONTACT",
        "email": "john.doe@acme.com",
        "name": "John Doe",
        "imageId": "1234!_qwer!_5667zxcvQWER!_ASDF",
        "emailId": "23456789",
        "userId": "12345678",
        "lookUpName": true
      }
    }
  ]
}