---
title: "Returns a list of jobs for a specified Experiment"
method: GET
path: "/api/v1/experiments/{id}/jobs"
tags: ["Experiments"]
---

# Returns a list of jobs for a specified Experiment

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

## Path parameters

- `id` integer, required

## Query parameters

- `sortBy` string
- `descending` boolean
- `search` string
- `index` integer
- `pageLength` integer

## Headers

- `X-Fields` string, mask

## Response `200`

Success

- JobPage
  - `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.
    - `description` string — Description of the Job resource.
    - `queue` QueueSnapshotRef
      - `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.
      - `name` string — Name of the Queue resource.
    - `experiment` ExperimentSnapshotRef
      - `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.
      - `name` string — Name of the Experiment resource.
    - `entrypoint` EntrypointSnapshotRef
      - `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.
      - `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.

---

[API](https://skmtc.net/usnistgov/apis/dioptra-rest-api.md) · [All operations](https://skmtc.net/usnistgov/apis/dioptra-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usnistgov/dioptra-rest-api/versions/a73101579c5c/schema)