# listSnapshots

Reads metadata for retained data snapshots.

Canonical: https://grid.syidax.com/docs/methods/listSnapshots/

<a id="meaning"></a>

## What does this API do?

Reads metadata for retained data snapshots.

<a id="contract"></a>

## Exact input and result types

```typescript
listSnapshots(): Promise<SnapshotMeta[]>
```

| Arguments | Required | Type |
| --- | --- | --- |

The return type is `Promise<SnapshotMeta[]>`.

<a id="usage"></a>

## Usage flow

After registering and initializing the Grid element, call grid.listSnapshots(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.

<a id="types"></a>

## Read related types

- [SnapshotMeta](https://grid.syidax.com/docs/types/SnapshotMeta.md)

<a id="recipes"></a>

## Feature explanations and examples

- [Data snapshot](https://grid.syidax.com/docs/features/snapshots.md) — Snapshots retain rowData at a point in time for comparison with current data or another snapshot. They differ from view-state APIs that save column widths, filters, and focus.