# List or read pool snapshots

URL: https://heaven.dev/docs/reference/pool-snapshots/view
Updated: 2026-11-21

List pool snapshots you can access or read one snapshot and its individual Computer snapshots. To copy a snapshot into a new pool, use `pool create`.

`GET /v1/pool/snapshot/`

## Parameters

- `pool` (string): The pool whose snapshots to list, by name or ID.
- `snapshot` (string): Pool snapshot name or ID. Includes its Computer snapshots.
- `shared` (boolean): Snapshot access filter: true for snapshots shared with you, false for your account's snapshots. Omit for both.
- `organization` (string): Organization name or ID. A credential, named resource or sole membership can select the organization for you.

## Returns

- `data` (object, always present): Accessible pool snapshots, or one snapshot with its per-Computer parts.
  - `alternative-1` (object): Pool snapshots you can read, including snapshots shared with you.
    - `pool_snapshots` (object[] | null, always present): Selected pool snapshots.
      - `items` (object): Disk snapshots captured from a pool. Sharing grants only disk-copy access.
        - `computers` (integer, always present): Number of Computers represented by its parts.
        - `created_at` (string (date-time), always present): When the grouped snapshot was created.
        - `created_by` (object, always present): Who requested the snapshot.
          - `email` (string | null, always present): Their email address, or null when none is available.
          - `user_id` (string, always present): Person's user ID.
        - `expires_at` (string (date-time) | null, always present): When it expires, or null if it has no expiry.
        - `id` (string, always present): Pool snapshot's ID.
        - `name` (string, always present): Its name within the pool.
        - `note` (string, always present): Saved note about the snapshot.
        - `parts` (object[]): Individual saved disks, included when reading one snapshot. May be omitted.
          - `items` (object): A Computer's disk snapshot within a pool snapshot. Copying a part requires both Computer and snapshot identities.
            - `computer` (object, always present): Source Computer.
            - `snapshot` (object, always present): Its saved disk snapshot.
        - `pool` (object, always present): Source pool and its account.
          - `id` (string, always present): Source pool's ID.
          - `name` (string, always present): Source pool's name.
          - `owner` (object, always present): Account that owns the source pool.
            - `account_id` (string, always present): Account ID.
            - `email` (string): Personal account owner's email. May be omitted.
            - `kind` (string, always present): Whether the owner is an organization or a personal account.
            - `name` (string): Organization name. May be omitted.
        - `region` (string): Region containing the source pool. May be omitted.
        - `shared` (boolean, always present): True when another account shared this snapshot with you.
        - `shared_with` (object[]): People this snapshot is shared with, visible to its account's members. May be omitted.
          - `items` (object): The person associated with a snapshot action or share.
            - `email` (string | null, always present): Their email address, or null when none is available.
            - `user_id` (string, always present): Person's user ID.
        - `state` (string, always present): Grouped snapshot's recorded state.
  - `alternative-2` (object): One pool snapshot and its per-Computer saved disks.
    - `pool_snapshot` (object, always present): Selected pool snapshot with its parts.
      - `computers` (integer, always present): Number of Computers represented by its parts.
      - `created_at` (string (date-time), always present): When the grouped snapshot was created.
      - `created_by` (object, always present): Who requested the snapshot.
        - `email` (string | null, always present): Their email address, or null when none is available.
        - `user_id` (string, always present): Person's user ID.
      - `expires_at` (string (date-time) | null, always present): When it expires, or null if it has no expiry.
      - `id` (string, always present): Pool snapshot's ID.
      - `name` (string, always present): Its name within the pool.
      - `note` (string, always present): Saved note about the snapshot.
      - `parts` (object[]): Individual saved disks, included when reading one snapshot. May be omitted.
        - `items` (object): A Computer's disk snapshot within a pool snapshot. Copying a part requires both Computer and snapshot identities.
          - `computer` (object, always present): Source Computer.
            - `id` (string, always present): Referenced object's stable ID.
            - `name` (string, always present): Referenced object's name.
          - `snapshot` (object, always present): Its saved disk snapshot.
            - `copies` (integer): Number of Computers copied from this part across accounts, visible only to source-account members. May be omitted.
            - `disk_bytes` (string | null, always present): Saved disk's logical size in bytes.
            - `expires_at` (string (date-time) | null, always present): When the saved snapshot expires, or null for no expiry.
            - `id` (string, always present): Individual snapshot's ID.
            - `name` (string, always present): Its name within the source Computer.
            - `saved` (string | null, always present): Disk capture method: `stopped`, `flushed` or `unflushed`. Null means capture is unreported.
            - `size_bytes` (string): Storage uniquely used by this snapshot, in bytes. May be omitted.
            - `state` (string, always present): Snapshot's recorded state.
            - `taken_at` (string (date-time) | null, always present): When the disk was captured, or null before capture is reported.
      - `pool` (object, always present): Source pool and its account.
        - `id` (string, always present): Source pool's ID.
        - `name` (string, always present): Source pool's name.
        - `owner` (object, always present): Account that owns the source pool.
          - `account_id` (string, always present): Account ID.
          - `email` (string): Personal account owner's email. May be omitted.
          - `kind` (string, always present): Whether the owner is an organization or a personal account.
          - `name` (string): Organization name. May be omitted.
      - `region` (string): Region containing the source pool. May be omitted.
      - `shared` (boolean, always present): True when another account shared this snapshot with you.
      - `shared_with` (object[]): People this snapshot is shared with, visible to its account's members. May be omitted.
        - `items` (object): The person associated with a snapshot action or share.
          - `email` (string | null, always present): Their email address, or null when none is available.
          - `user_id` (string, always present): Person's user ID.
      - `state` (string, always present): Grouped snapshot's recorded state.

## Errors

Each code is explained in full at https://heaven.dev/docs/reference/errors.

| Code | Status | What happened |
|---|---:|---|
| `invalid` | 400 | An input is missing or invalid. |
| `unauthenticated` | 401 | The credential is missing, invalid, expired or revoked. |
| `denied` | 403 | The caller lacks permission for this action. |
| `not_found` | 404 | The resource is absent or inaccessible to this caller. |
| `conflict` | 409 | The request conflicts with the current resource state or an earlier request. |
| `over_capacity` | 409 | The request exceeds a resource or credential allowance. |
| `access_list_full` | 409 | The change would exceed the access-list allowance. |
| `rate_limited` | 429 | The caller's request rate exceeds its limit. |
| `busy` | 429 | Too much work is in progress to accept this request. |
| `unknown` | 503 | The outcome is unconfirmed; a change may have happened. |
| `unavailable` | 503 | The service or requested feature is unavailable. |

## Notes

- API key permission: `pool snapshot view`.

## Examples

```sh tab="heaven CLI"
heaven pool snapshot view [POOL] [SNAPSHOT]
  [--shared true|false]
  [--organization ORGANIZATION]
```

```sh tab="SSH"
ssh cli@heaven.dev pool snapshot view [POOL] [SNAPSHOT]
  [--shared true|false]
  [--organization ORGANIZATION]
```

```sh tab="cURL"
curl https://heaven.dev/v1/pool/snapshot/ \
  -H "Authorization: Bearer $HEAVEN_API_KEY"
```

```json tab="MCP"
{ "tool": "pool_snapshot_view",
  "arguments": {  } }
```

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "pool_snapshots": []
  }
}
```
