---
title: "List snapshots"
method: GET
path: "/snapshots"
tags: ["snapshots"]
---

# List snapshots

`GET /snapshots`

List all snapshots of a sheet

## Query parameters

- `sheetId` string, required — Sheet ID
- `threadId` string

## Headers

- `Authorization` string, required
- `X-Disable-Hooks` 'true', required

## Response `200`

Response with status 200

- TypeSnapshotsSnapshotsResponse
  - `data` TypeSnapshotsSnapshot[], required
    - `id` string, required — Snapshot ID
    - `sheetId` string, required — Sheet ID
    - `label` string — The title of the Snapshot.
    - `threadId` string — The ID of the thread associated with the snapshot.
    - `summary` TypeSnapshotsSnapshotSummary
      - `createdSince` TypeSnapshotsSummarySection, required
        - `total` integer, required
        - `byField` object
      - `updatedSince` TypeSnapshotsSummarySection, required
        - `total` integer, required
        - `byField` object
      - `deletedSince` TypeSnapshotsSummarySection, required
        - `total` integer, required
        - `byField` object
      - `schemaDiff` TypeSnapshotsSchemaDiffRecord, required
      - `config` TypeSheetsSheetConfig, required — Describes shape of data as well as behavior
        - `name` string, required — The name of your Sheet as it will appear to your end users.
        - `description` string — A sentence or two describing the purpose of your Sheet.
        - `slug` string — A unique identifier for your Sheet.
        - `readonly` boolean — A boolean specifying whether or not this sheet is read only. Read only sheets are not editable by end users.
        - `allowAdditionalFields` boolean — Allow end users to add fields during mapping.
        - `mappingConfidenceThreshold` number, double — The minimum confidence required to automatically map a field
        - `access` TypeSheetsSheetAccess[] — Control Sheet-level access for all users.
        - `fields` TypePropertyProperty[], required — Where you define your Sheet's data schema.
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
        - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Sheet.
          - `slug` string — **This is deprecated. Use `operation` instead.**
          - `operation` string — This will become the job operation that is triggered
          - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete
          - `tooltip` string — A tooltip that appears when hovering the action button
          - `messages` TypeCommonsActionMessage[]
            - `type` 'error' | 'info', required
            - `content` string, required
          - `type` string — **This is deprecated.**
          - `description` string — The text that appears in the dialog after the action is clicked.
          - `schedule` 'weekly' | 'daily' | 'hourly'
          - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook.
          - `confirm` boolean — Whether to show a modal to confirm the action
          - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon.
          - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.**
          - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.**
          - `inputForm` TypeCommonsInputForm
            - `type` 'simple', required
            - `fields` TypeCommonsInputField[], required
              - …
          - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action.
            - union
              - …
          - `mount` union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
          - `guide` TypeCommonsGuide
            - `content` string, required — Markdown guidance for this action
          - `guardrail` TypeCommonsGuardrail
            - `content` string, required — Markdown guardrail for this action
          - `createdFrom` string — Action ID
          - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook
          - `deletedAt` string, date-time — The time this action was deleted
          - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description
          - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true)
          - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true)
          - `label` string, required — The text on the Button itself
        - `metadata` unknown
        - `constraints` TypeSheetsSheetConstraint[] — An array of constraints that end users can perform on this Sheet.
          - union
            - object
              - …
            - object
              - …
        - `treatments` TypeSheetsSheetTreatments[] — An array of treatments that define the behavior of the sheet.
        - `collection` string — Collection in which to group the sheet
    - `createdAt` string, date-time, required — The time the Snapshot was created.
    - `createdBy` string, required — User ID

## Other responses

- `400` — Error response with status 400
- `404` — Error response with status 404

---

[API](https://skmtc.net/flatfile/apis/api-reference.md) · [All operations](https://skmtc.net/flatfile/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flatfile/api-reference/revisions/9d3a9979cd96/schema)