---
title: "Gets the Snapshots for the resource"
method: GET
path: "/api/v1/jobs/{id}/snapshots"
tags: ["Job"]
---

# Gets the Snapshots for the resource

`GET /api/v1/jobs/{id}/snapshots`

## Request

- Base URL: `/` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/v1/jobs/{id}/snapshots`
- Auth: none declared
- TypeScript: <https://skmtc.dev/usnistgov/apis/dioptra-rest-api/docs/api/v1/jobs/:id/snapshots/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `search` string
- `index` integer
- `pageLength` integer

## Headers

- `X-Fields` string, mask

## Response `200`

Success

- SnapshotsJobPage
  - `index` integer: Starting index of the current page.
  - `isComplete` boolean: Boolean indicating if more data is available.
  - `totalNumResults` integer: Total number of results.
  - `first` string: URL to first page in results set.
  - `next` string: URL to next page in results set.
  - `prev` string: URL to last page in results set.
  - `data` JobDump[]
    - `id` integer: ID for the Job resource.
    - `snapshot` integer: ID for the underlying Job snapshot.
    - `group` GroupRef
      - `id` integer: ID for the Group resource.
      - `name` string: Name of the Group resource.
      - `url` string: URL for accessing the full Group resource.
    - `user` UserRefDump
      - `id` integer: ID for the User resource.
      - `username` string: Username of the User resource.
      - `url` string: URL for accessing the full User resource.
    - `createdOn` string, date-time: Timestamp when the Job resource was created.
    - `snapshotCreatedOn` string, date-time: Timestamp when the Job resource snapshot was created.
    - `lastModifiedOn` string, date-time: Timestamp when the Job resource was last modified.
    - `latestSnapshot` boolean: Whether or not the Job resource is the latest version.
    - `hasDraft` boolean: Whether a draft exists for the Job resource.
    - `tags` TagRefDump[]
      - `id` integer: ID for the Tag.
      - `name` string: Name of the Tag.
      - `group` GroupRef
        - `id` integer: ID for the Group resource.
        - `name` string: Name of the Group resource.
        - `url` string: URL for accessing the full Group resource.
      - `url` string: URL for accessing the full Tag.
    - `deleted` boolean: Whether the Job resource has been deleted.
    - `description` string: Description of the Job resource.
    - `queue` QueueSnapshotRefDump
      - `id` integer: ID for the Queue resource.
      - `snapshotId` integer: Snapshot ID for the Queue resource.
      - `group` GroupRef
        - `id` integer: ID for the Group resource.
        - `name` string: Name of the Group resource.
        - `url` string: URL for accessing the full Group resource.
      - `url` string: URL for accessing the full Queue resource.
      - `deleted` boolean: Whether the Queue resource has been deleted.
      - `name` string: Name of the Queue resource.
    - `experiment` ExperimentSnapshotRefDump
      - `id` integer: ID for the Experiment resource.
      - `snapshotId` integer: Snapshot ID for the Experiment resource.
      - `group` GroupRef
        - `id` integer: ID for the Group resource.
        - `name` string: Name of the Group resource.
        - `url` string: URL for accessing the full Group resource.
      - `url` string: URL for accessing the full Experiment resource.
      - `deleted` boolean: Whether the Experiment resource has been deleted.
      - `name` string: Name of the Experiment resource.
    - `entrypoint` EntrypointSnapshotRefDump
      - `id` integer: ID for the Entrypoint resource.
      - `snapshotId` integer: Snapshot ID for the Entrypoint resource.
      - `group` GroupRef
        - `id` integer: ID for the Group resource.
        - `name` string: Name of the Group resource.
        - `url` string: URL for accessing the full Group resource.
      - `url` string: URL for accessing the full Entrypoint resource.
      - `deleted` boolean: Whether the Entrypoint resource has been deleted.
      - `name` string: Name of the Entrypoint resource.
    - `values` object: A dictionary of keyword arguments to pass to the Job's Entrypoint.
    - `artifactValues` object: A dictionary of artifacts to pass to the Job's Entrypoint.
    - `timeout` string: The maximum alloted time for a job before it times out and is stopped. If omitted, the job timeout will default to 24 hours.
    - `status` string: The current status of the job. The allowed values are: queued, started, deferred, finished, failed.
    - `artifacts` ArtifactRefDump[]
      - `id` integer: ID for the Artifact resource.
      - `group` GroupRef
        - `id` integer: ID for the Group resource.
        - `name` string: Name of the Group resource.
        - `url` string: URL for accessing the full Group resource.
      - `url` string: URL for accessing the full Artifact Resource.
      - `deleted` boolean: Whether the Artifact resource has been deleted.
    - `swaps` JobSwapDump[]: Swap choices selected for the Job resource.
      - `swapName` string: Name of the swap.
      - `taskAlias` string: Alias of the chosen task.
      - `pluginFileResourceSnapshotId` integer: Resource snapshot ID of the plugin file containing the chosen task.

## Changes

- **2026-09-30** `7615a76631a4`: 10 breaking, 1 warning, 10 info
  - the `data/items/` response's property type changed from `object` to no type for status `200`
  - the `data/items/allOf[#/components/schemas/Job-dump]/artifacts/items/` response's property type changed from `object` to no type for status `200`
  - the `data/items/allOf[#/components/schemas/Job-dump]/artifacts/items/allOf[#/components/schemas/ArtifactRef-dump]/group` response's property type changed from `object` to no type for status `200`
  - the `data/items/allOf[#/components/schemas/Job-dump]/entrypoint` response's property type changed from `object` to no type for status `200`
  - …17 more
- **2026-02-11** `a73101579c5c`: 7 info
  - added the optional property `data/items/allOf[#/components/schemas/Job-dump]/artifactValues` to the response with the `200` status
  - added the optional property `data/items/allOf[#/components/schemas/Job-dump]/entrypoint/allOf[#/components/schemas/EntrypointSnapshotRef]/id` to the response with the `200` status
  - added the optional property `data/items/allOf[#/components/schemas/Job-dump]/experiment/allOf[#/components/schemas/ExperimentSnapshotRef]/id` to the response with the `200` status
  - added the optional property `data/items/allOf[#/components/schemas/Job-dump]/queue/allOf[#/components/schemas/QueueSnapshotRef]/id` to the response with the `200` status
  - …3 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/usnistgov/apis/dioptra-rest-api/changes/api/v1/jobs/:id/snapshots/get.md)

---

[API](https://skmtc.dev/usnistgov/apis/dioptra-rest-api.md) - [All operations](https://skmtc.dev/usnistgov/apis/dioptra-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/usnistgov/apis/dioptra-rest-api/revisions/e1a0ec3a40b2?raw)