---
title: "Get Workflow"
method: GET
path: "/api/workflow/{name}"
tags: ["Workflow API"]
---

# Get Workflow

`GET /api/workflow/{name}`

## Request

- The document declares no server URL.
- Auth: none declared

Returns the workflow with the given name in the database.

## Path parameters

- `name` string, required

## Query parameters

- `skip_groups` boolean
- `verbose` boolean

## Response `200`

Successful Response

- WorkflowQueryResponse: Represents the queryed workflow information.
  - `name` string, required
  - `uuid` string, required
  - `submitted_by` string, required
  - `cancelled_by` string, nullable
  - `spec` string, required
  - `template_spec` string, required
  - `logs` string, required
  - `events` string, required
  - `overview` string, required
  - `parent_name` string, nullable
  - `parent_job_id` integer, nullable
  - `dashboard_url` string, nullable
  - `grafana_url` string, nullable
  - `tags` string[]
  - `submit_time` string, date-time, required
  - `start_time` string, date-time, nullable
  - `end_time` string, date-time, nullable
  - `exec_timeout` number, nullable
  - `queue_timeout` number, nullable
  - `duration` number, nullable
  - `queued_time` number, required
  - `status` 'PENDING' | 'RUNNING' | 'WAITING' | 'COMPLETED' | 'FAILED' | 'FAILED_SUBMISSION' | 'FAILED_SERVER_ERROR' | 'FAILED_EXEC_TIMEOUT' | 'FAILED_QUEUE_TIMEOUT' | 'FAILED_CANCELED' | 'FAILED_BACKEND_ERROR' | 'FAILED_IMAGE_PULL' | 'FAILED_EVICTED' | 'FAILED_START_ERROR' | 'FAILED_START_TIMEOUT' | 'FAILED_PREEMPTED', required: Represents the status of a workflow.
  - `outputs` string
  - `groups` GroupQueryResponse[], required
    - `name` string, required
    - `status` 'SUBMITTING' | 'WAITING' | 'PROCESSING' | 'SCHEDULING' | 'INITIALIZING' | 'RUNNING' | 'COMPLETED' | 'RESCHEDULED' | 'FAILED' | 'FAILED_CANCELED' | 'FAILED_SERVER_ERROR' | 'FAILED_BACKEND_ERROR' | 'FAILED_EXEC_TIMEOUT' | 'FAILED_QUEUE_TIMEOUT' | 'FAILED_IMAGE_PULL' | 'FAILED_UPSTREAM' | 'FAILED_EVICTED' | 'FAILED_START_ERROR' | 'FAILED_START_TIMEOUT' | 'FAILED_PREEMPTED', required: Represents the status of a task group
    - `start_time` string, date-time, nullable
    - `end_time` string, date-time, nullable
    - `processing_start_time` string, date-time, nullable
    - `scheduling_start_time` string, date-time, nullable
    - `initializing_start_time` string, date-time, nullable
    - `remaining_upstream_groups` string[], nullable
    - `downstream_groups` string[], nullable
    - `failure_message` string, nullable
    - `tasks` TaskQueryResponse[]
      - `name` string, required
      - `retry_id` integer, required
      - `status` 'SUBMITTING' | 'WAITING' | 'PROCESSING' | 'SCHEDULING' | 'INITIALIZING' | 'RUNNING' | 'COMPLETED' | 'RESCHEDULED' | 'FAILED' | 'FAILED_CANCELED' | 'FAILED_SERVER_ERROR' | 'FAILED_BACKEND_ERROR' | 'FAILED_EXEC_TIMEOUT' | 'FAILED_QUEUE_TIMEOUT' | 'FAILED_IMAGE_PULL' | 'FAILED_UPSTREAM' | 'FAILED_EVICTED' | 'FAILED_START_ERROR' | 'FAILED_START_TIMEOUT' | 'FAILED_PREEMPTED', required: Represents the status of a task group
      - `failure_message` string, nullable
      - `exit_code` integer, nullable
      - `logs` string, required
      - `error_logs` string, nullable
      - `processing_start_time` string, date-time, nullable
      - `scheduling_start_time` string, date-time, nullable
      - `initializing_start_time` string, date-time, nullable
      - `events` string, required
      - `start_time` string, date-time, nullable
      - `end_time` string, date-time, nullable
      - `input_download_start_time` string, date-time, nullable
      - `input_download_end_time` string, date-time, nullable
      - `output_upload_start_time` string, date-time, nullable
      - `dashboard_url` string, nullable
      - `pod_name` string, required
      - `pod_ip` string, nullable
      - `task_uuid` string, required
      - `node_name` string, nullable
      - `lead` boolean
  - `pool` string, nullable
  - `backend` string, nullable
  - `app_owner` string, nullable
  - `app_name` string, nullable
  - `app_version` integer, nullable
  - `plugins` WorkflowPlugins, required: Represents the state of plugins in a workflow upon submission.
    - `rsync` boolean
  - `priority` string, required
  - `labels` object
  - `warnings` string[]

## Other responses

- `422`: Validation Error

## Changes

- **2026-08-03** `b9d312a13f5d`: 4 info
  - added the optional property `detail/items/ctx` to the response with the `422` status
  - added the optional property `detail/items/input` to the response with the `422` status
  - added the optional property `labels` to the response with the `200` status
  - added the optional property `warnings` to the response with the `200` status
- **2026-04-08** `a8157dc3279d`: 40 breaking
  - response property `app_name` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `app_owner` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `app_version` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `backend` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - …36 more
- **2026-03-31** `639e39b0d1eb`: 1 breaking, 31 info
  - the response's body type changed from `string` to `object` for status `200`
  - added the optional property `app_name` to the response with the `200` status
  - added the optional property `app_owner` to the response with the `200` status
  - added the optional property `app_version` to the response with the `200` status
  - …28 more

[Operation history](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/changes/api/workflow/:name/get.md)

---

[API](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api.md) - [All operations](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/revisions/845585a71dbb?raw)