---
title: "List cross-sheet references"
method: GET
path: "/sheets/{sheetId}/crosssheetreferences"
tags: ["crossSheetReferences"]
---

# List cross-sheet references

`GET /sheets/{sheetId}/crosssheetreferences`

Lists all cross-sheet references for the sheet.

> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).

## Query parameters

- `includeAll` boolean
- `page` number
- `pageSize` number

## Response `200`

IndexResult object containing an array of CrossSheetReference objects.

**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).

- object
  - `pageNumber` number — The current page in the full result set that the data array represents. NOTE when a page number greater than totalPages is requested, the last page is instead returned.
  - `pageSize` number, nullable — The number of items in a page. Omitted if there is no limit to page size (and hence, all results are included). Unless otherwise specified, this defaults to 100 for most endpoints.
  - `totalPages` number — The total number of pages in the full result set.
  - `totalCount` number — The total number of items in the full result set.
  - `data` CrossSheetReference[]
    - `endColumnId` number — Defines ending edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.
    - `endRowId` number — Defines ending edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.
    - `id` number — Cross-sheet reference ID, guaranteed unique within referencing sheet.
    - `name` string — Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References.
    - `startColumnId` number — Defines beginning edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.
    - `startRowId` number — Defines beginning edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.
    - `status` 'BLOCKED' | 'BROKEN' | 'CIRCULAR' | 'DISABLED' | 'INVALID/UNKNOWN' | 'NOT-SHARED' | 'OK' — Status of request: * 'BLOCKED' - A reference is downstream of a circular issue. * 'BROKEN' - The data source location (column, row or sheet) was deleted. * 'CIRCULAR' - The formula reference is self referencing and cannot be resolved. * 'DISABLED' - Updating the reference is temporarily disabled due to maintenance. * 'INVALID/UNKNOWN' - The reference is new and had not been validated. * 'NOT_SHARED' - No common shared users. * 'OK' - The reference is in a good state.
    - `sourceSheetId` number — Sheet ID of source sheet.

## 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)