# List dashboards

Gets a list of all dashboards that the user has access to.

> Note: For pagination guidance, refer to Token-based pagination.

Endpoint: GET /sights
Version: 2.0.0
Security: APIToken, OAuth2

## Header parameters:

  - `Authorization` (string)
    API Access Token used to authenticate requests to Smartsheet APIs.

  - `smartsheet-integration-source` (string)
    Uses the following metadata to distinguish between human-initiated API requests and third-party service-initiated calls by AI Connectors or ITSM:

- Integration source type
- Organization name
- Integration source name 

Format:


TYPE,OrgName,SourceName


Examples: 

AI,SampleOrg,My-AI-Connector-v2

SCRIPT,SampleOrg2,Accounting-updater-script

APPLICATION,SampleOrg3,SheetUpdater
    Example: "AI,SampleOrg,My-AI-Connector-v2"

## Query parameters:

  - `numericDates` (boolean)
    You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request.

  - `lastKey` (string)
    The lastKey token returned from the previous page of results. If not specified,
the first page of results is returned.
    Example: "abcDefGhIjKlMnOpQrStUvWxYz"

  - `paginationType` (string)
    Specifies the type of pagination to use. When set to 'token', enables token-based pagination.
    Enum: "token"

  - `maxItems` (integer)
    The maximum number of items to return in the response. The actual number of items returned may be less than maxItems.

If the total number of dashboards the user has access to exceeds maxItems, the response will include a lastKey field. This key can be used as a parameter in subsequent requests to retrieve additional items beyond those already returned.

  - `includeAll` (boolean)
    If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified).

DEPRECATED - As early as the sunset date specified in this Changelog entry, this request parameter will no longer be supported.

  - `modifiedSince` (any)
    When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version.

DEPRECATED - As early as the sunset date specified in this Changelog entry, this request parameter will no longer be supported.

  - `page` (number)
    Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned.

DEPRECATED - As early as the sunset date specified in this Changelog entry, this request parameter will no longer be supported.

  - `pageSize` (number)
    The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a
page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request.

DEPRECATED - As early as the sunset date specified in this Changelog entry, this request parameter will no longer be supported.

## Response 200 fields (application/json):

  - `lastKey` (string)
    A token that is used to retrieve the next page of results when passed as the
lastKey query parameter. This value will be absent when there are no 
further pages.
    Example: "abcDefGhIjKlMnOpQrStUvWxYz"

  - `data` (array)
    List of Dashboards

  - `data.createdAt` (any)

  - `data.modifiedAt` (any)

  - `data.id` (number)
    Dashboard ID.

  - `data.accessLevel` (string)
    Enum: "ADMIN", "COMMENTER", "EDITOR", "EDITOR_SHARE", "OWNER", "VIEWER"

  - `data.permalink` (string)
    URL that represents a direct link to the dashboard in Smartsheet.

  - `data.name` (string)
    Dashboard name.

  - `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.

DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#deprecated-includeall-and-offset-based-pagination-for-dashboards), this response property will not be part of the response.
    Example: 1

  - `pageSize` (number,null)
    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.

DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#deprecated-includeall-and-offset-based-pagination-for-dashboards), this response property will not be part of the response.
    Example: 50

  - `totalPages` (number)
    The total number of pages in the full result set.

DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#deprecated-includeall-and-offset-based-pagination-for-dashboards), this response property will not be part of the response.
    Example: 25

  - `totalCount` (number)
    The total number of items in the full result set.

DEPRECATED - As early as the sunset date specified in this [Changelog entry](/api/smartsheet/changelog#deprecated-includeall-and-offset-based-pagination-for-dashboards), this response property will not be part of the response.
    Example: 136

## Response default fields (application/json):

  - `refId` (string)
    The ID of the specific error occurrence. Please include this information when contacting Smartsheet support.

  - `errorCode` (number)
    Custom error code from Smartsheet. See the complete [Error Code List](/api/smartsheet/error-codes).

  - `message` (string)
    Descriptive error message.