---
title: "Get sheet summary"
method: GET
path: "/sheets/{sheetId}/summary"
tags: ["sheetSummary"]
---

# Get sheet summary

`GET /sheets/{sheetId}/summary`

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

## Query parameters

- `include` 'format' | 'writerInfo'
- `exclude` 'displayValue' | 'image' | 'imageAltText'

## Response `200`

OK

- SheetSummary — Represents the entire summary, or a list of defined fields and values, for a specific sheet.
  - `fields` SummaryField[] — Array of summary (or metadata) fields defined on the sheet.
    - `id` number — SummaryField ID.
    - `contactOptions` ContactOption[] — Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST.
      - `email` string — A parsable email address.
      - `name` string — Can be a user's name, display name, or free text.
    - `createdAt` union
      - string, date-time
      - number
    - `createdBy` MiniUser — MiniUser Object
      - `email` string, email
      - `name` string
    - `displayValue` string — Visual representation of cell contents, as presented to the user in the UI.
    - `format` string — The format descriptor. Only returned if the include query string parameter contains format and this column has a non-default format applied to it.
    - `formula` string — The formula for a cell, if set.
    - `hyperlink` Hyperlink
      - `reportId` number — If non-null, this hyperlink is a link to the report with this ID.
      - `sheetId` number — If non-null, this hyperlink is a link to the sheet with this ID.
      - `sightId` number — If non-null, this hyperlink is a link to the dashboard with this ID.
      - `url` string — When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a dashboard/report/sheet link (that is, dashboardId, reportId, or sheetId is non-null), this property contains the permalink to the dashboard, report, or sheet.
    - `image` Image
      - `altText` string — Alternate text for the image.
      - `height` number — Original height (in pixels) of the uploaded image.
      - `id` string — Image ID.
      - `width` number — Original width (in pixels) of the uploaded image.
    - `index` number — Field index or position. This number is zero-based.
    - `locked` boolean — Indicates whether the field is locked.
    - `lockedForUser` boolean — Indicates whether the field is locked for the requesting user.
    - `modifiedAt` union
      - string, date-time
      - number
    - `modifiedBy` MiniUser — MiniUser Object
      - `email` string, email
      - `name` string
    - `objectValue` union
      - string
      - number
      - boolean
      - ContactObjectValue — Object containing a Contact
        - `objectType` 'CONTACT'
        - `email` string, email — Email address of the Contact
        - `name` string — Name of the Contact
        - `imageId` string — ID of an image associated with the Contact
        - `emailId` string — ID of the email address
        - `userId` string — User ID of the contact
        - `lookUpName` boolean — Whether or not to look up the contact's name based on their email address.
      - DateObjectValue — Object representing a date
        - `objectType` 'DATE'
        - `value` string, date — Date in the **full-date** format defined by <a href="https://tools.ietf.org/html/rfc3339#section-5.6" target="_blank" rel="noopener noreferrer">RFC 3339, section 5.6</a>
    - `options` string[] — When applicable for PICKLIST column type. Array of the options available for the field.
    - `symbol` string — When applicable for PICKLIST column type.
    - `title` string — Arbitrary name, must be unique within summary.
    - `type` 'ABSTRACT_DATETIME' | 'CHECKBOX' | 'CONTACT_LIST' | 'DATE' | 'DATETIME' | 'DURATION' | 'MULTI_CONTACT_LIST' | 'MULTI_PICKLIST' | 'PICKLIST' | 'PREDECESSOR' | 'TEXT_NUMBER'
    - `validation` boolean — Indicates whether summary field values are restricted to the type.

## Other responses

- `default` — Generic Error Payload

---

[API](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference.md) · [All operations](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smartsheet/smartsheet-openapi-reference/versions/b4afda95fb51/schema)