---
title: "Get a list of snapshots for a pipeline by pipeline id"
method: GET
path: "/pipelines/{id}/snapshots"
tags: ["Pipeline Operations"]
---

# Get a list of snapshots for a pipeline by pipeline id

`GET /pipelines/{id}/snapshots`

## Request

- Base URL: `https://replace-with-account.api.decodable.co/v1alpha2`
- URL: `https://replace-with-account.api.decodable.co/v1alpha2/pipelines/{id}/snapshots`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://auth.decodable.co/authorize?audience=https://api.decodable.co/`
    - Token URL: `https://auth.decodable.co/oauth/token` scopes: `read:pipeline`
- TypeScript: <https://skmtc.dev/decodable/apis/decodable-control-plane/docs/pipelines/:id/snapshots/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `page_size` integer
- `page_token` string

## Response `200`

A list of snapshots.

- object
  - `next_page_token` string: A token that, that when passed to a subsequent call as page_token, will return the next page of results.
  - `items` Snapshot[], required: An array of snapshots.
    - `id` string: An identifier for the snapshot
    - `job_id` string: The id of the pipeline or connection that initially created the snapshot.
    - `name` string: The name of the snapshot.
    - `type` 'SCHEDULED' | 'ONE_TIME': The scheduling type of the snapshot.
    - `start_time` string, date-time: The date and time the snapshot was started.
    - `end_time` string, date-time: The date and time the snapshot was completed.
    - `retention_time` string, date-time: The date and time the snapshot will be retained until.
    - `state` 'SCHEDULED' | 'FINISHED' | 'FAILED' | 'EXPIRED' | 'DELETING' | 'DELETED': The current state of the snapshot.

## Other responses

- `400`: An invalid request was received.
- `403`: Access denied: requesting user lacks a required permission.
- `404`: The requested resource does not exist.
- `default`: An error has occurred.

---

[API](https://skmtc.dev/decodable/apis/decodable-control-plane.md) - [All operations](https://skmtc.dev/decodable/apis/decodable-control-plane/llms.txt) - [OpenAPI document](https://skmtc.dev/decodable/apis/decodable-control-plane/revisions/9718a3019da8?raw)